Shypple API v0.1.2
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
This is the documentation for programmatically interfacing with Shypple.
Every request to this API needs to be authenticated using an API Token, provided in the HTTP header X-Api-Token.
This token can be obtained by logging into the application at https://app.shypple.com/organization_settings/api_token
For example, if the token is xxx.yyy.zzz then the header should be X-Api-Token: xxx.yyy.zzz
Versioning
When we make backward-incompatible changes to the schemas in our api, we release a new version of these entity/entities.
These versions are dated, which means you can specify the date in your API requests, for which
the object versions are guaranteed to be the same no matter which changes we release afterwards.
To set the schema version on a specific request, send a Shypple-Version header.
# Example of using Shypple-Version header
curl -X GET https://api.shypple.com/public/v1/sample_entity/{id}
-H 'Accept: application/json'
-H 'X-Api-Token: API_KEY'
-H 'Shypple-Version: 2019-12-25'
By using this header, you ensure that response will contain objects schemas that were actual as of specified date.
Base URLs:
Authentication
- API Key (Authorization)
- Parameter Name: X-Api-Token, in: header.
Containers
Operations about Containers
Get a container by ID
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/containers/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/containers/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/containers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/containers/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/containers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/containers/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/containers/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/containers/{id}
To retrieve all the containers by shipment ID, send a request to the /shipments/:shipment_id/containers endpoint.
Returns a 404 error if no container can be found with the provided ID.
Returns a 400 error if the provided ID is not an integer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Container id. |
Example responses
200 Response
{
"id": 0,
"status": "string",
"container_event_exceptions": [
"string"
],
"shared_reference": "string",
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"number": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"seal_number": "string",
"type": "string",
"devanning_date": "2019-08-24",
"discharged_at": "2019-08-24T14:15:22Z",
"total_cargo_weight_kg": 0,
"total_volume_cbm": 0,
"packages": 0,
"hs_codes": [
{
"id": 0,
"goods_code": "string",
"description": "string",
"notes": "string"
}
],
"cargo": [
{
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
],
"inland_transports": [
{
"id": 0,
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"shipment_details": "string",
"modality": "string",
"carrier": "string",
"cargo_weight_kg": "string",
"service": "string",
"status": "string",
"transporter_status": "string",
"pickup_delivery_time": "2019-08-24T14:15:22Z",
"closing_time": "2019-08-24T14:15:22Z",
"pickup_delivery_time_editable": true,
"inland_transport_addresses": [
{
"id": 0,
"inland_transport": {
"id": 0,
"service": "string",
"url": "string"
},
"pickup_delivery": true,
"reference": "string",
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"datetime_status": "string",
"datetime_manageable?": {},
"url": "string",
"name": "string",
"address_id": 0,
"address_type": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"comment": "string",
"vat_number": "string",
"eori_number": "string",
"latitude": 0,
"longitude": 0
}
],
"url": "string"
}
],
"url": "string",
"container_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"event_type_description": "string",
"template_variables": {},
"exception": "string"
}
],
"milestones": "string",
"temperature": "string",
"humidity": "string",
"vents_open": true,
"drains_open": true,
"co2_regulation": "string",
"ventilation": "string",
"comments": "string",
"equipment_controlled_atmosphere": true,
"tare_weight_kg": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a single container | Public_Entities_ContainerV2 |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
Confirms pickup/delivery time
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/containers/{id}/confirm_datetime \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/containers/{id}/confirm_datetime HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"service_type": "pickup"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}/confirm_datetime',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"service_type": "pickup"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}/confirm_datetime',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/containers/{id}/confirm_datetime',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/containers/{id}/confirm_datetime', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/containers/{id}/confirm_datetime");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/containers/{id}/confirm_datetime", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/containers/{id}/confirm_datetime', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/containers/{id}/confirm_datetime
Request to confirm pickup/delivery time. Requires an address to be already selected before proceeding this request.
Returns a 404 error if no container can be found with the provided ID.
Returns a 422 error if status of the transport is not proposed.
Body parameter
{
"service_type": "pickup"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | patchV1ContainersIdConfirmDatetime | true | none |
Example responses
200 Response
{
"id": 0,
"status": "string",
"container_event_exceptions": [
"string"
],
"shared_reference": "string",
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"number": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"seal_number": "string",
"type": "string",
"devanning_date": "2019-08-24",
"discharged_at": "2019-08-24T14:15:22Z",
"total_cargo_weight_kg": 0,
"total_volume_cbm": 0,
"packages": 0,
"hs_codes": [
{
"id": 0,
"goods_code": "string",
"description": "string",
"notes": "string"
}
],
"cargo": [
{
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
],
"inland_transports": [
{
"id": 0,
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"shipment_details": "string",
"modality": "string",
"carrier": "string",
"cargo_weight_kg": "string",
"service": "string",
"status": "string",
"transporter_status": "string",
"pickup_delivery_time": "2019-08-24T14:15:22Z",
"closing_time": "2019-08-24T14:15:22Z",
"pickup_delivery_time_editable": true,
"inland_transport_addresses": [
{
"id": 0,
"inland_transport": {
"id": 0,
"service": "string",
"url": "string"
},
"pickup_delivery": true,
"reference": "string",
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"datetime_status": "string",
"datetime_manageable?": {},
"url": "string",
"name": "string",
"address_id": 0,
"address_type": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"comment": "string",
"vat_number": "string",
"eori_number": "string",
"latitude": 0,
"longitude": 0
}
],
"url": "string"
}
],
"url": "string",
"container_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"event_type_description": "string",
"template_variables": {},
"exception": "string"
}
],
"milestones": "string",
"temperature": "string",
"humidity": "string",
"vents_open": true,
"drains_open": true,
"co2_regulation": "string",
"ventilation": "string",
"comments": "string",
"equipment_controlled_atmosphere": true,
"tare_weight_kg": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Confirms pickup/delivery time | Public_Entities_ContainerV2 |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Unprocessable Entity | Public_Entities_Error |
Assigns a pickup/delivery reference
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/containers/{id}/assign_reference \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/containers/{id}/assign_reference HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"reference": "string",
"service_type": "pickup"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}/assign_reference',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"reference": "string",
"service_type": "pickup"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}/assign_reference',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/containers/{id}/assign_reference',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/containers/{id}/assign_reference', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/containers/{id}/assign_reference");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/containers/{id}/assign_reference", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/containers/{id}/assign_reference', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/containers/{id}/assign_reference
Assigns a reference to the pickup/delivery.
Returns a 404 error if no container can be found with the provided ID.
Body parameter
{
"reference": "string",
"service_type": "pickup"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | patchV1ContainersIdAssignReference | true | none |
Example responses
200 Response
{
"id": 0,
"status": "string",
"container_event_exceptions": [
"string"
],
"shared_reference": "string",
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"number": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"seal_number": "string",
"type": "string",
"devanning_date": "2019-08-24",
"discharged_at": "2019-08-24T14:15:22Z",
"total_cargo_weight_kg": 0,
"total_volume_cbm": 0,
"packages": 0,
"hs_codes": [
{
"id": 0,
"goods_code": "string",
"description": "string",
"notes": "string"
}
],
"cargo": [
{
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
],
"inland_transports": [
{
"id": 0,
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"shipment_details": "string",
"modality": "string",
"carrier": "string",
"cargo_weight_kg": "string",
"service": "string",
"status": "string",
"transporter_status": "string",
"pickup_delivery_time": "2019-08-24T14:15:22Z",
"closing_time": "2019-08-24T14:15:22Z",
"pickup_delivery_time_editable": true,
"inland_transport_addresses": [
{
"id": 0,
"inland_transport": {
"id": 0,
"service": "string",
"url": "string"
},
"pickup_delivery": true,
"reference": "string",
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"datetime_status": "string",
"datetime_manageable?": {},
"url": "string",
"name": "string",
"address_id": 0,
"address_type": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"comment": "string",
"vat_number": "string",
"eori_number": "string",
"latitude": 0,
"longitude": 0
}
],
"url": "string"
}
],
"url": "string",
"container_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"event_type_description": "string",
"template_variables": {},
"exception": "string"
}
],
"milestones": "string",
"temperature": "string",
"humidity": "string",
"vents_open": true,
"drains_open": true,
"co2_regulation": "string",
"ventilation": "string",
"comments": "string",
"equipment_controlled_atmosphere": true,
"tare_weight_kg": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Assigns a reference to the container pickup/delivery | Public_Entities_ContainerV2 |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Unprocessable Entity | Public_Entities_Error |
Assigns a pickup/delivery datetime
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/containers/{id}/assign_datetime \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/containers/{id}/assign_datetime HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"service_type": "pickup"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}/assign_datetime',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"service_type": "pickup"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}/assign_datetime',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/containers/{id}/assign_datetime',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/containers/{id}/assign_datetime', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/containers/{id}/assign_datetime");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/containers/{id}/assign_datetime", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/containers/{id}/assign_datetime', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/containers/{id}/assign_datetime
Assigns a datetime in ISO format.
Returns a 404 error if no container can be found with the provided ID.
Returns a 400 error if datetime_to <= datetime_from, datetime_to has a different date, datetime is not within
range 8AM - 6PM or minutes value is not 00 or 30.
Returns a 422 error if pickup/delivery details was already confirmed.
Returns a 422 error if datetime currently is not editable due to other reasons.
Body parameter
{
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"service_type": "pickup"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | patchV1ContainersIdAssignDatetime | true | none |
Example responses
200 Response
{
"id": 0,
"status": "string",
"container_event_exceptions": [
"string"
],
"shared_reference": "string",
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"number": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"seal_number": "string",
"type": "string",
"devanning_date": "2019-08-24",
"discharged_at": "2019-08-24T14:15:22Z",
"total_cargo_weight_kg": 0,
"total_volume_cbm": 0,
"packages": 0,
"hs_codes": [
{
"id": 0,
"goods_code": "string",
"description": "string",
"notes": "string"
}
],
"cargo": [
{
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
],
"inland_transports": [
{
"id": 0,
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"shipment_details": "string",
"modality": "string",
"carrier": "string",
"cargo_weight_kg": "string",
"service": "string",
"status": "string",
"transporter_status": "string",
"pickup_delivery_time": "2019-08-24T14:15:22Z",
"closing_time": "2019-08-24T14:15:22Z",
"pickup_delivery_time_editable": true,
"inland_transport_addresses": [
{
"id": 0,
"inland_transport": {
"id": 0,
"service": "string",
"url": "string"
},
"pickup_delivery": true,
"reference": "string",
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"datetime_status": "string",
"datetime_manageable?": {},
"url": "string",
"name": "string",
"address_id": 0,
"address_type": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"comment": "string",
"vat_number": "string",
"eori_number": "string",
"latitude": 0,
"longitude": 0
}
],
"url": "string"
}
],
"url": "string",
"container_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"event_type_description": "string",
"template_variables": {},
"exception": "string"
}
],
"milestones": "string",
"temperature": "string",
"humidity": "string",
"vents_open": true,
"drains_open": true,
"co2_regulation": "string",
"ventilation": "string",
"comments": "string",
"equipment_controlled_atmosphere": true,
"tare_weight_kg": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Assigns a datetime for pickup/delivery to the container | Public_Entities_ContainerV2 |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Unprocessable Entity | Public_Entities_Error |
Assign a pickup/delivery address
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/containers/{id}/assign_address \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/containers/{id}/assign_address HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"address_id": 0,
"service_type": "pickup"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}/assign_address',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"address_id": 0,
"service_type": "pickup"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/containers/{id}/assign_address',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/containers/{id}/assign_address',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/containers/{id}/assign_address', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/containers/{id}/assign_address");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/containers/{id}/assign_address", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/containers/{id}/assign_address', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/containers/{id}/assign_address
Assign an address from your address book, /addresses endpoint, as the pickup or delivery address of a container.
Only existing addresses can be used as pickup or delivery addresses for your containers.
Unique address ID can be obtained from either an address creation request or the address list.
Returns a 404 error if no container can be found with the provided ID.
Returns a 404 error(with a different message) if no address can be found with the provided address_id parameter.
Returns a 400 error if provided ID is not an integer.
Body parameter
{
"address_id": 0,
"service_type": "pickup"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | patchV1ContainersIdAssignAddress | true | none |
Example responses
200 Response
{
"id": 0,
"status": "string",
"container_event_exceptions": [
"string"
],
"shared_reference": "string",
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"number": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"seal_number": "string",
"type": "string",
"devanning_date": "2019-08-24",
"discharged_at": "2019-08-24T14:15:22Z",
"total_cargo_weight_kg": 0,
"total_volume_cbm": 0,
"packages": 0,
"hs_codes": [
{
"id": 0,
"goods_code": "string",
"description": "string",
"notes": "string"
}
],
"cargo": [
{
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
],
"inland_transports": [
{
"id": 0,
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"shipment_details": "string",
"modality": "string",
"carrier": "string",
"cargo_weight_kg": "string",
"service": "string",
"status": "string",
"transporter_status": "string",
"pickup_delivery_time": "2019-08-24T14:15:22Z",
"closing_time": "2019-08-24T14:15:22Z",
"pickup_delivery_time_editable": true,
"inland_transport_addresses": [
{
"id": 0,
"inland_transport": {
"id": 0,
"service": "string",
"url": "string"
},
"pickup_delivery": true,
"reference": "string",
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"datetime_status": "string",
"datetime_manageable?": {},
"url": "string",
"name": "string",
"address_id": 0,
"address_type": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"comment": "string",
"vat_number": "string",
"eori_number": "string",
"latitude": 0,
"longitude": 0
}
],
"url": "string"
}
],
"url": "string",
"container_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"event_type_description": "string",
"template_variables": {},
"exception": "string"
}
],
"milestones": "string",
"temperature": "string",
"humidity": "string",
"vents_open": true,
"drains_open": true,
"co2_regulation": "string",
"ventilation": "string",
"comments": "string",
"equipment_controlled_atmosphere": true,
"tare_weight_kg": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Assigns a pickup/delivery address to the container | Public_Entities_ContainerV2 |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Unprocessable Entity | Public_Entities_Error |
Bookings
Operations about Bookings
Create a new booking
Code samples
# You can also use wget
curl -X POST https://api.shypple.com/public/v1/bookings \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
POST https://api.shypple.com/public/v1/bookings HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"shipment_id": 0,
"booking_reference": "string",
"cargo_ready_date": "2019-08-24",
"incoterm_code": "string",
"consignee_as_notify_party": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"shipment_id": 0,
"booking_reference": "string",
"cargo_ready_date": "2019-08-24",
"incoterm_code": "string",
"consignee_as_notify_party": true
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.post 'https://api.shypple.com/public/v1/bookings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.post('https://api.shypple.com/public/v1/bookings', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/bookings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.shypple.com/public/v1/bookings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.shypple.com/public/v1/bookings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
POST /v1/bookings
Create a new booking.
Body parameter
{
"shipment_id": 0,
"booking_reference": "string",
"cargo_ready_date": "2019-08-24",
"incoterm_code": "string",
"consignee_as_notify_party": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | postV1Bookings | true | none |
Example responses
201 Response
{
"id": 0,
"url": "string",
"booking_reference": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"cargo_ready_date": "2019-08-24",
"house_bl": "string",
"incoterm": "string",
"commercial_invoice_and_packing_list_uploaded": true,
"booking_parties_information_complete": true,
"consignee_as_notify_party": true,
"shipment_documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"shipper": {},
"consignee": {},
"notify_party": {},
"booking_events": {
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"template_variables": {}
},
"purchase_orders": {
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
},
"booking_index": "string",
"milestones": {
"id": 0,
"name": "string",
"code": "string",
"reached": true,
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"status": "string",
"booking_level": true,
"container_level": true,
"tasks": {
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Create a new booking | Public_Entities_Booking |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Get a single booking
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/bookings/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/bookings/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/bookings/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/bookings/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/bookings/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/bookings/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/bookings/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/bookings/{id}
Get a single booking
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Booking id. |
Example responses
200 Response
{
"id": 0,
"url": "string",
"booking_reference": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"cargo_ready_date": "2019-08-24",
"house_bl": "string",
"incoterm": "string",
"commercial_invoice_and_packing_list_uploaded": true,
"booking_parties_information_complete": true,
"consignee_as_notify_party": true,
"shipment_documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"shipper": {},
"consignee": {},
"notify_party": {},
"booking_events": {
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"template_variables": {}
},
"purchase_orders": {
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
},
"booking_index": "string",
"milestones": {
"id": 0,
"name": "string",
"code": "string",
"reached": true,
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"status": "string",
"booking_level": true,
"container_level": true,
"tasks": {
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Get a single booking | Public_Entities_Booking |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Update an existing booking
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/bookings/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/bookings/{id} HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"booking_reference": "string",
"cargo_ready_date": "2019-08-24",
"incoterm_code": "string",
"consignee_as_notify_party": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"booking_reference": "string",
"cargo_ready_date": "2019-08-24",
"incoterm_code": "string",
"consignee_as_notify_party": true
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/bookings/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/bookings/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/bookings/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/bookings/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/bookings/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/bookings/{id}
Update an existing booking
Body parameter
{
"booking_reference": "string",
"cargo_ready_date": "2019-08-24",
"incoterm_code": "string",
"consignee_as_notify_party": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Booking id. |
| body | body | patchV1BookingsId | true | none |
Example responses
200 Response
{
"id": 0,
"url": "string",
"booking_reference": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"cargo_ready_date": "2019-08-24",
"house_bl": "string",
"incoterm": "string",
"commercial_invoice_and_packing_list_uploaded": true,
"booking_parties_information_complete": true,
"consignee_as_notify_party": true,
"shipment_documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"shipper": {},
"consignee": {},
"notify_party": {},
"booking_events": {
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"template_variables": {}
},
"purchase_orders": {
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
},
"booking_index": "string",
"milestones": {
"id": 0,
"name": "string",
"code": "string",
"reached": true,
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"status": "string",
"booking_level": true,
"container_level": true,
"tasks": {
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Update an existing booking | Public_Entities_Booking |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Assign an address to a booking
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/bookings/{id}/assign_address \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/bookings/{id}/assign_address HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"address_id": 0,
"booking_party": "shipper"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}/assign_address',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"address_id": 0,
"booking_party": "shipper"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}/assign_address',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/bookings/{id}/assign_address',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/bookings/{id}/assign_address', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/bookings/{id}/assign_address");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/bookings/{id}/assign_address", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/bookings/{id}/assign_address', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/bookings/{id}/assign_address
Assign an address to a booking.
Note that the address_id must be a valid address. Find the IDs of
addresses in the public/v1/addresses API.
Body parameter
{
"address_id": 0,
"booking_party": "shipper"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Booking id. |
| body | body | patchV1BookingsIdAssignAddress | true | none |
Example responses
200 Response
{
"id": 0,
"url": "string",
"booking_reference": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"cargo_ready_date": "2019-08-24",
"house_bl": "string",
"incoterm": "string",
"commercial_invoice_and_packing_list_uploaded": true,
"booking_parties_information_complete": true,
"consignee_as_notify_party": true,
"shipment_documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"shipper": {},
"consignee": {},
"notify_party": {},
"booking_events": {
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"template_variables": {}
},
"purchase_orders": {
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
},
"booking_index": "string",
"milestones": {
"id": 0,
"name": "string",
"code": "string",
"reached": true,
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"status": "string",
"booking_level": true,
"container_level": true,
"tasks": {
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Assign an address to a booking | Public_Entities_Booking |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Assign a contact to a booking
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/bookings/{id}/assign_contact \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/bookings/{id}/assign_contact HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"contact_id": 0,
"booking_party": "shipper"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}/assign_contact',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"contact_id": 0,
"booking_party": "shipper"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}/assign_contact',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/bookings/{id}/assign_contact',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/bookings/{id}/assign_contact', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/bookings/{id}/assign_contact");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/bookings/{id}/assign_contact", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/bookings/{id}/assign_contact', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/bookings/{id}/assign_contact
Assign a contact to a booking.
Note that the contact_id must be a valid contact. Find the IDs of
contacts in the public/v1/contacts API.
Body parameter
{
"contact_id": 0,
"booking_party": "shipper"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Booking id. |
| body | body | patchV1BookingsIdAssignContact | true | none |
Example responses
200 Response
{
"id": 0,
"url": "string",
"booking_reference": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"cargo_ready_date": "2019-08-24",
"house_bl": "string",
"incoterm": "string",
"commercial_invoice_and_packing_list_uploaded": true,
"booking_parties_information_complete": true,
"consignee_as_notify_party": true,
"shipment_documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"shipper": {},
"consignee": {},
"notify_party": {},
"booking_events": {
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"template_variables": {}
},
"purchase_orders": {
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
},
"booking_index": "string",
"milestones": {
"id": 0,
"name": "string",
"code": "string",
"reached": true,
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"status": "string",
"booking_level": true,
"container_level": true,
"tasks": {
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Assign a contact to a booking | Public_Entities_Booking |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Assign an address and a contact to a booking
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/bookings/{id}/assign_address_and_contact \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/bookings/{id}/assign_address_and_contact HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"address_id": 0,
"contact_id": 0,
"booking_party": "shipper"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}/assign_address_and_contact',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"address_id": 0,
"contact_id": 0,
"booking_party": "shipper"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/bookings/{id}/assign_address_and_contact',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/bookings/{id}/assign_address_and_contact',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/bookings/{id}/assign_address_and_contact', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/bookings/{id}/assign_address_and_contact");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/bookings/{id}/assign_address_and_contact", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/bookings/{id}/assign_address_and_contact', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/bookings/{id}/assign_address_and_contact
Assign an address and a contact to a booking.
Note that the address_id must be a valid address. Find the IDs of
addresses in the public/v1/addresses API.
And contact_id must be a valid contact. Find the IDs of
contacts in the public/v1/contacts API.
Body parameter
{
"address_id": 0,
"contact_id": 0,
"booking_party": "shipper"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Booking id. |
| body | body | patchV1BookingsIdAssignAddressAndContact | true | none |
Example responses
200 Response
{
"id": 0,
"url": "string",
"booking_reference": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"cargo_ready_date": "2019-08-24",
"house_bl": "string",
"incoterm": "string",
"commercial_invoice_and_packing_list_uploaded": true,
"booking_parties_information_complete": true,
"consignee_as_notify_party": true,
"shipment_documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"shipper": {},
"consignee": {},
"notify_party": {},
"booking_events": {
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"template_variables": {}
},
"purchase_orders": {
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
},
"booking_index": "string",
"milestones": {
"id": 0,
"name": "string",
"code": "string",
"reached": true,
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"status": "string",
"booking_level": true,
"container_level": true,
"tasks": {
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Assign an address and a contact to a booking | Public_Entities_Booking |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Addresses
Operations about Addresses
List all addresses
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/addresses \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/addresses HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/addresses',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/addresses', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/addresses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/addresses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/addresses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/addresses
Retrieve all addresses saved in your address book.
Supply the unique address ID from your address book when assigning a
pickup or delivery address to your container or when creating a Booking.
Example responses
200 Response
[
{
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List all addresses | Inline |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_Address] | false | none | [Public_Entities_Address model] |
| » id | integer(int32) | true | none | The unique Shypple identifier |
| » url | string | true | none | The url to this address |
| » name | string | true | none | The address name |
| » address | string | false | none | Street street name |
| » postal_code | string | false | none | The postal code |
| » city | string | false | none | The city |
| » country | Public_Entities_Country | true | none | Public_Entities_Country model |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» name | string | true | none | The name of the country |
| »» title | string | false | none | DEPRECATED - use attribute "name" instead |
| »» code | string | true | none | The code |
| »» trade_zone | string | true | none | BENELUX for BE/NL/LU, country code for the others. |
| string | false | none | The email address | |
| » phone | string | false | none | The phone number |
| » vat_number | string | false | none | The VAT number |
| » eori_number | string | false | none | The EORI number |
| » comment | string | false | none | Additional information about the address. |
| » default | boolean | false | none | Whether this is the default shipping address. |
| » connection | Public_Entities_Organization | false | none | none |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» name | string | true | none | The name |
| »» prefix | string | true | none | The prefix |
| »» configured_po_upload | boolean | false | none | Configured Purchase Order tool upload? |
| »» logo | string | false | none | URL of the organization logo |
| »» role_code | string | true | none | Code of the organization role |
| »» default_address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »» preferred_shipment_role_id | integer(int32) | true | none | ID of the prefered shipment role |
| »» preferred_forwarder_id | integer(int32) | true | none | ID of preferred freight forwarder connection |
| »» public_documents | string | false | none | none |
| » updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| » ports | [Public_Entities_Port] | false | none | All ports |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» name | string | true | none | The name |
| »» code | string | true | none | The 5-character UN Locode identifier of this port |
| »» display_name | string | false | none | The display name |
| »» type | string | false | none | The port type |
| »» country | Public_Entities_Country | false | none | Public_Entities_Country model |
| »» time_zone | string | false | none | none |
| » preferred_modalities | [string] | false | none | All preferred modalities |
| » sla_checkpoints | [Public_Entities_SLACheckpoint] | false | none | All SLA checkpoints |
| »» id | integer(int32) | true | none | The unique Shypple identifier. |
| »» name | string | true | none | The name of this SLA checkpoint. |
| »» dt_days | integer(int32) | true | none | The delta of days (negative is in the past). |
| »» has_info_requests | boolean | false | none | none |
| »» owner | Public_Entities_User | true | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier of the user. |
| »»» full_name | string | false | none | Full name of the user. |
| string | true | none | Email of the user. | |
| »»» organization_name | string | false | none | Name of the user organization. |
| »»» last_active | string(date-time) | true | none | The point in time when this entity was seen last time in ISO 8601 format |
| »»» out_of_office_till | string(date-time) | false | none | The date the user is out of office until in ISO 8601 format |
| »»» avatar | string | false | none | URL of user avatar |
| »» sla_checkpoint_type | Public_Entities_SLACheckpointType | true | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»» code | string | true | none | The code of this SLA checkpoint. |
| »»» name | string | true | none | The name of this SLA checkpoint. |
| »» sla_checkpoint_value | Public_Entities_SLACheckpointValue | true | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» date_field | string | true | none | The name of the date field |
| »»» description | string | true | none | The description of the date field |
| »» created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| »» sla_checkpoint_addresses | Public_Entities_SLACheckpointAddress | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»» automated_alert | boolean | true | none | Indicates if alerts for this address are enabled for the SLA checkpoint. |
| »»» address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »» due_date_message_status | Public_Entities_DueDateMessageStatus | false | none | none |
| »»» due_date | string(date) | false | none | The due date for the SLA checkpoint belonging to the purchase order. |
| »»» message_status | string | false | none | The message status of the SLA checkpoint belonging to the purchase order. |
| » full_text | string | false | none | Full text of address |
Creates a new address
Code samples
# You can also use wget
curl -X POST https://api.shypple.com/public/v1/addresses \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
POST https://api.shypple.com/public/v1/addresses HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"vat_number": "string",
"eori_number": "string",
"country_id": 0,
"phone": "string",
"email": "string",
"comment": "string",
"port_ids": [
0
],
"preferred_modalities": [
"string"
],
"visiting_instructions": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"vat_number": "string",
"eori_number": "string",
"country_id": 0,
"phone": "string",
"email": "string",
"comment": "string",
"port_ids": [
0
],
"preferred_modalities": [
"string"
],
"visiting_instructions": [
"string"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.post 'https://api.shypple.com/public/v1/addresses',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.post('https://api.shypple.com/public/v1/addresses', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/addresses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.shypple.com/public/v1/addresses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.shypple.com/public/v1/addresses', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
POST /v1/addresses
Create a new address in your address book.
To assign a pickup or delivery address to your container or when creating a Booking,
supply the unique address ID in your assign_address request.
Body parameter
{
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"vat_number": "string",
"eori_number": "string",
"country_id": 0,
"phone": "string",
"email": "string",
"comment": "string",
"port_ids": [
0
],
"preferred_modalities": [
"string"
],
"visiting_instructions": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | postV1Addresses | true | none |
Example responses
201 Response
{
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Creates an address | Public_Entities_Address |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Get an address by ID
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/addresses/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/addresses/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/addresses/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/addresses/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/addresses/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/addresses/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/addresses/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/addresses/{id}
Retrieve an existing address from your address book. Supply the unique address ID from either an address creation request or the address list, and Shypple will return the corresponding address from your address book.
Returns a 404 error if no address can be found with the provided ID.
Returns a 400 error if the provided ID is not an integer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Address id. |
Example responses
200 Response
{
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a single address | Public_Entities_Address |
| 400 | Bad Request | Bad Request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not Found | Public_Entities_Error |
Updates an address by ID
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/addresses/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/addresses/{id} HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"vat_number": "string",
"eori_number": "string",
"country_id": 0,
"phone": "string",
"email": "string",
"comment": "string",
"port_ids": [
0
],
"preferred_modalities": [
"string"
],
"visiting_instructions": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"vat_number": "string",
"eori_number": "string",
"country_id": 0,
"phone": "string",
"email": "string",
"comment": "string",
"port_ids": [
0
],
"preferred_modalities": [
"string"
],
"visiting_instructions": [
"string"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/addresses/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/addresses/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/addresses/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/addresses/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/addresses/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/addresses/{id}
Updates the specific address by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Body parameter
{
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"vat_number": "string",
"eori_number": "string",
"country_id": 0,
"phone": "string",
"email": "string",
"comment": "string",
"port_ids": [
0
],
"preferred_modalities": [
"string"
],
"visiting_instructions": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | patchV1AddressesId | true | none |
Example responses
200 Response
{
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Updates an address by ID | Public_Entities_Address |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not Found | Public_Entities_Error |
| 422 | Unprocessable Entity | Unprocessable Entity | Public_Entities_Error |
Delete an address
Code samples
# You can also use wget
curl -X DELETE https://api.shypple.com/public/v1/addresses/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
DELETE https://api.shypple.com/public/v1/addresses/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.delete 'https://api.shypple.com/public/v1/addresses/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.delete('https://api.shypple.com/public/v1/addresses/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/addresses/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.shypple.com/public/v1/addresses/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.shypple.com/public/v1/addresses/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
DELETE /v1/addresses/{id}
Endpoint to delete a single address.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Address ID |
Example responses
401 Response
{
"error": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Delete an address | None |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Forbidden | Public_Entities_Error |
| 404 | Not Found | Not Found | Public_Entities_Error |
Countries
Operations about Countries
Get a list of countries
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/countries \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/countries HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/countries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/countries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/countries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/countries', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/countries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/countries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/countries', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/countries
Retrieve a list of countries and their two-letter ISO country code.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| search | query | string | false | Country search substring. Search is possible by name OR code. |
Example responses
200 Response
[
{
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a list of countries | Inline |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_Country] | false | none | [Public_Entities_Country model] |
| » id | integer(int32) | true | none | The unique Shypple identifier |
| » name | string | true | none | The name of the country |
| » title | string | false | none | DEPRECATED - use attribute "name" instead |
| » code | string | true | none | The code |
| » trade_zone | string | true | none | BENELUX for BE/NL/LU, country code for the others. |
Contacts
Operations about Contacts
List all contacts
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/contacts \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/contacts HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/contacts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/contacts', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/contacts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/contacts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/contacts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/contacts
Retrieve all contacts from your organization.
Example responses
200 Response
[
{
"id": 0,
"name": "string",
"email": "string",
"phone": "string",
"company_address_id": 0,
"company_name": "string",
"company_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"organization_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"comment": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List all contacts | Inline |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_Contact] | false | none | [Public_Entities_Contact model] |
| » id | integer(int32) | true | none | The unique Shypple identifier |
| » name | string | true | none | The name |
| string | true | none | The email address | |
| » phone | string | true | none | The phone number |
| » company_address_id | integer(int32) | false | none | The identifier of the company address |
| » company_name | string | false | none | The company name |
| » company_address | Public_Entities_Address | false | none | Public_Entities_Address model |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» url | string | true | none | The url to this address |
| »» name | string | true | none | The address name |
| »» address | string | false | none | Street street name |
| »» postal_code | string | false | none | The postal code |
| »» city | string | false | none | The city |
| »» country | Public_Entities_Country | true | none | Public_Entities_Country model |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | The name of the country |
| »»» title | string | false | none | DEPRECATED - use attribute "name" instead |
| »»» code | string | true | none | The code |
| »»» trade_zone | string | true | none | BENELUX for BE/NL/LU, country code for the others. |
| string | false | none | The email address | |
| »» phone | string | false | none | The phone number |
| »» vat_number | string | false | none | The VAT number |
| »» eori_number | string | false | none | The EORI number |
| »» comment | string | false | none | Additional information about the address. |
| »» default | boolean | false | none | Whether this is the default shipping address. |
| »» connection | Public_Entities_Organization | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | The name |
| »»» prefix | string | true | none | The prefix |
| »»» configured_po_upload | boolean | false | none | Configured Purchase Order tool upload? |
| »»» logo | string | false | none | URL of the organization logo |
| »»» role_code | string | true | none | Code of the organization role |
| »»» default_address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »»» preferred_shipment_role_id | integer(int32) | true | none | ID of the prefered shipment role |
| »»» preferred_forwarder_id | integer(int32) | true | none | ID of preferred freight forwarder connection |
| »»» public_documents | string | false | none | none |
| »» updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| »» ports | [Public_Entities_Port] | false | none | All ports |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | The name |
| »»» code | string | true | none | The 5-character UN Locode identifier of this port |
| »»» display_name | string | false | none | The display name |
| »»» type | string | false | none | The port type |
| »»» country | Public_Entities_Country | false | none | Public_Entities_Country model |
| »»» time_zone | string | false | none | none |
| »» preferred_modalities | [string] | false | none | All preferred modalities |
| »» sla_checkpoints | [Public_Entities_SLACheckpoint] | false | none | All SLA checkpoints |
| »»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»» name | string | true | none | The name of this SLA checkpoint. |
| »»» dt_days | integer(int32) | true | none | The delta of days (negative is in the past). |
| »»» has_info_requests | boolean | false | none | none |
| »»» owner | Public_Entities_User | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier of the user. |
| »»»» full_name | string | false | none | Full name of the user. |
| string | true | none | Email of the user. | |
| »»»» organization_name | string | false | none | Name of the user organization. |
| »»»» last_active | string(date-time) | true | none | The point in time when this entity was seen last time in ISO 8601 format |
| »»»» out_of_office_till | string(date-time) | false | none | The date the user is out of office until in ISO 8601 format |
| »»»» avatar | string | false | none | URL of user avatar |
| »»» sla_checkpoint_type | Public_Entities_SLACheckpointType | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»»» code | string | true | none | The code of this SLA checkpoint. |
| »»»» name | string | true | none | The name of this SLA checkpoint. |
| »»» sla_checkpoint_value | Public_Entities_SLACheckpointValue | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» date_field | string | true | none | The name of the date field |
| »»»» description | string | true | none | The description of the date field |
| »»» created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| »»» sla_checkpoint_addresses | Public_Entities_SLACheckpointAddress | false | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»»» automated_alert | boolean | true | none | Indicates if alerts for this address are enabled for the SLA checkpoint. |
| »»»» address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »»» due_date_message_status | Public_Entities_DueDateMessageStatus | false | none | none |
| »»»» due_date | string(date) | false | none | The due date for the SLA checkpoint belonging to the purchase order. |
| »»»» message_status | string | false | none | The message status of the SLA checkpoint belonging to the purchase order. |
| »» full_text | string | false | none | Full text of address |
| » organization_id | integer(int32) | true | none | The identifier of the organization |
| » updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| » comment | string | false | none | Additional information about the contact |
Creates a new contact
Code samples
# You can also use wget
curl -X POST https://api.shypple.com/public/v1/contacts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
POST https://api.shypple.com/public/v1/contacts HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"email": "string",
"phone": "string",
"company_name": "string",
"company_address": "string",
"company_address_id": 0,
"organization_id": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "string",
"email": "string",
"phone": "string",
"company_name": "string",
"company_address": "string",
"company_address_id": 0,
"organization_id": 0
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.post 'https://api.shypple.com/public/v1/contacts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.post('https://api.shypple.com/public/v1/contacts', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/contacts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.shypple.com/public/v1/contacts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.shypple.com/public/v1/contacts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
POST /v1/contacts
Create a new contact in your address book.
Body parameter
{
"name": "string",
"email": "string",
"phone": "string",
"company_name": "string",
"company_address": "string",
"company_address_id": 0,
"organization_id": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | postV1Contacts | true | none |
Example responses
201 Response
{
"id": 0,
"name": "string",
"email": "string",
"phone": "string",
"company_address_id": 0,
"company_name": "string",
"company_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"organization_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"comment": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Creates a contact | Public_Entities_Contact |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Get a contact by ID
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/contacts/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/contacts/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/contacts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/contacts/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/contacts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/contacts/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/contacts/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/contacts/{id}
To retrieve all the contacts by address ID, send a request to the /addresses/:address_id/contacts endpoint.
Returns a 404 error if no contact can be found with the provided ID.
Returns a 400 error if the provided ID is not an integer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Contact id. |
Example responses
200 Response
{
"id": 0,
"name": "string",
"email": "string",
"phone": "string",
"company_address_id": 0,
"company_name": "string",
"company_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"organization_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"comment": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a single contact | Public_Entities_Contact |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
Updates a contact by ID
Code samples
# You can also use wget
curl -X PATCH https://api.shypple.com/public/v1/contacts/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PATCH https://api.shypple.com/public/v1/contacts/{id} HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "string",
"email": "string",
"phone": "string",
"company_name": "string",
"company_address": "string",
"company_address_id": 0,
"organization_id": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "string",
"email": "string",
"phone": "string",
"company_name": "string",
"company_address": "string",
"company_address_id": 0,
"organization_id": 0
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.patch 'https://api.shypple.com/public/v1/contacts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.patch('https://api.shypple.com/public/v1/contacts/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/contacts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.shypple.com/public/v1/contacts/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','https://api.shypple.com/public/v1/contacts/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PATCH /v1/contacts/{id}
Updates the specific contact by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Body parameter
{
"name": "string",
"email": "string",
"phone": "string",
"company_name": "string",
"company_address": "string",
"company_address_id": 0,
"organization_id": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | patchV1ContactsId | true | none |
Example responses
200 Response
{
"id": 0,
"name": "string",
"email": "string",
"phone": "string",
"company_address_id": 0,
"company_name": "string",
"company_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"organization_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"comment": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Updates a contact by ID | Public_Entities_Contact |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Unprocessable Entity | Public_Entities_Error |
Delete acontact
Code samples
# You can also use wget
curl -X DELETE https://api.shypple.com/public/v1/contacts/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
DELETE https://api.shypple.com/public/v1/contacts/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/contacts/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.delete 'https://api.shypple.com/public/v1/contacts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.delete('https://api.shypple.com/public/v1/contacts/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/contacts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.shypple.com/public/v1/contacts/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.shypple.com/public/v1/contacts/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
DELETE /v1/contacts/{id}
Endpoint to delete a single contact.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Contact ID |
Example responses
401 Response
{
"error": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Delete a contact | None |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Access denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
Carriers
Operations about Carriers
Get a list of carriers
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/carriers \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/carriers HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/carriers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/carriers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/carriers',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/carriers', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/carriers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/carriers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/carriers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/carriers
Retrieve a list of carriers and their Shypple IDs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | integer(int32) | false | Page number |
| per_page | query | integer(int32) | false | Number of results per page |
| search | query | string | false | Carrier search substring. Search is possible by name OR code. |
Example responses
200 Response
[
{
"id": 0,
"name": "string",
"scac": "string",
"carrier_alliance_name": "string",
"carrier_alliance_code": "string",
"preferred_tracking_key": "string",
"ocean_insights_coverage": "string",
"carrier_type": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a list of carriers | Inline |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_Carrier] | false | none | [Public_Entities_Carrier model] |
| » id | integer(int32) | true | none | The unique Shypple identifier |
| » name | string | true | none | The name |
| » scac | string | true | none | Standard Carrier Alpha Code (SCAC) |
| » carrier_alliance_name | string | false | none | none |
| » carrier_alliance_code | string | false | none | none |
| » preferred_tracking_key | string | false | none | none |
| » ocean_insights_coverage | string | false | none | none |
| » carrier_type | string | false | none | none |
PackageTypes
Operations about PackageTypes
Get a list of package types
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/package_types \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/package_types HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/package_types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/package_types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/package_types',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/package_types', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/package_types");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/package_types", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/package_types', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/package_types
Retrieves a list of package types Shypple has to offer.
Example responses
200 Response
[
{
"id": 0,
"code": "string",
"name": "string",
"description": "string",
"default_length_mm": 0,
"default_width_mm": 0,
"default_height_mm": 0,
"default_type": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a list of package types | Inline |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_PackageType] | false | none | [Public_Entities_PackageType model] |
| » id | integer(int32) | true | none | The unique Shypple identifier for this package type. |
| » code | string | true | none | The code |
| » name | string | true | none | The name |
| » description | string | false | none | The description |
| » default_length_mm | integer(int32) | false | none | The default length in millimeters |
| » default_width_mm | integer(int32) | false | none | The default width in millimeters |
| » default_height_mm | integer(int32) | false | none | The default height in millimeters |
| » default_type | boolean | true | none | Is default package type? |
Get a list of product groups
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/product_groups \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/product_groups HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/product_groups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/product_groups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/product_groups',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/product_groups', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/product_groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/product_groups", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/product_groups', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/product_groups
Retrieves a list of product groups Shypple has to offer.
Example responses
200 Response
[
{
"id": 0,
"name": "string",
"code": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a list of product groups | Inline |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_ProductGroup] | false | none | [Public_Entities_ProductGroup model] |
| » id | integer(int32) | true | none | The unique Shypple identifier for this product group. |
| » name | string | true | none | Name of the product group. |
| » code | string | true | none | Unique code of the product group. |
Incoterms
Operations about Incoterms
List all incoterms
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/incoterms \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/incoterms HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/incoterms',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/incoterms',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/incoterms',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/incoterms', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/incoterms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/incoterms", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/incoterms', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/incoterms
Retrieves all incoterms.
Example responses
200 Response
[
{
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List all incoterms | Inline |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_Incoterm] | false | none | [Public_Entities_Incoterm model] |
| » id | integer(int32) | true | none | The unique Shypple identifier for this incoterm. |
| » priority | integer(int32) | false | none | The priority. |
| » code | string | true | none | Incoterm code. |
| » name | string | true | none | Descriptive incoterm name. |
| » role_services | [any] | false | none | Services per shipment role |
PurchaseOrders
Operations about PurchaseOrders
Get a single purchase orders
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/purchase_orders/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/purchase_orders/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/purchase_orders/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/purchase_orders/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/purchase_orders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/purchase_orders/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/purchase_orders/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/purchase_orders/{id}
Get a single purchase orders
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Purchase Order id. |
Example responses
200 Response
{
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Get a single purchase order | Public_Entities_PurchaseOrder |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Delete a single purchase orders
Code samples
# You can also use wget
curl -X DELETE https://api.shypple.com/public/v1/purchase_orders/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
DELETE https://api.shypple.com/public/v1/purchase_orders/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.delete 'https://api.shypple.com/public/v1/purchase_orders/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.delete('https://api.shypple.com/public/v1/purchase_orders/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/purchase_orders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.shypple.com/public/v1/purchase_orders/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.shypple.com/public/v1/purchase_orders/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
DELETE /v1/purchase_orders/{id}
Delete a single purchase orders
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Purchase Order id. |
Example responses
400 Response
{
"error": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Delete a single purchase order | None |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Update an existing purchase order
Code samples
# You can also use wget
curl -X PUT https://api.shypple.com/public/v1/purchase_orders/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
PUT https://api.shypple.com/public/v1/purchase_orders/{id} HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"purchase_order_number": "string",
"seller_address_id": 0,
"seller_address_name": "string",
"incoterm_code": "string",
"loading_port_code": "string",
"loading_port_name": "string",
"ex_factory_date": "2019-08-24",
"order_date": "2019-08-24",
"cargo_ready_date": "2019-08-24",
"purchase_order_lines": [
{
"id": 0,
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"booking_lines": [
{
"weight_kg": 0,
"volume_cbm": 0
}
]
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"purchase_order_number": "string",
"seller_address_id": 0,
"seller_address_name": "string",
"incoterm_code": "string",
"loading_port_code": "string",
"loading_port_name": "string",
"ex_factory_date": "2019-08-24",
"order_date": "2019-08-24",
"cargo_ready_date": "2019-08-24",
"purchase_order_lines": [
{
"id": 0,
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"booking_lines": [
{
"weight_kg": 0,
"volume_cbm": 0
}
]
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders/{id}',
{
method: 'PUT',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.put 'https://api.shypple.com/public/v1/purchase_orders/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.put('https://api.shypple.com/public/v1/purchase_orders/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/purchase_orders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://api.shypple.com/public/v1/purchase_orders/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.shypple.com/public/v1/purchase_orders/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
PUT /v1/purchase_orders/{id}
Update an existing purchase order.
Body parameter
{
"purchase_order_number": "string",
"seller_address_id": 0,
"seller_address_name": "string",
"incoterm_code": "string",
"loading_port_code": "string",
"loading_port_name": "string",
"ex_factory_date": "2019-08-24",
"order_date": "2019-08-24",
"cargo_ready_date": "2019-08-24",
"purchase_order_lines": [
{
"id": 0,
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"booking_lines": [
{
"weight_kg": 0,
"volume_cbm": 0
}
]
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Purchase Order id. |
| body | body | putV1PurchaseOrdersId | true | none |
Example responses
200 Response
{
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Update an existing purchase order | Public_Entities_PurchaseOrder |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Get all purchase orders
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/purchase_orders \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/purchase_orders HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/purchase_orders',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/purchase_orders', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/purchase_orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/purchase_orders", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/purchase_orders', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/purchase_orders
Get all purchase orders
Example responses
200 Response
{
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Get all purchase orders | Public_Entities_PurchaseOrder |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
Create a new purchase order
Code samples
# You can also use wget
curl -X POST https://api.shypple.com/public/v1/purchase_orders \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
POST https://api.shypple.com/public/v1/purchase_orders HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"purchase_order_number": "string",
"seller_address_id": 0,
"seller_address_name": "string",
"incoterm_code": "string",
"loading_port_code": "string",
"loading_port_name": "string",
"ex_factory_date": "2019-08-24",
"order_date": "2019-08-24",
"cargo_ready_date": "2019-08-24",
"purchase_order_lines": [
{
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"booking_lines": [
{
"weight_kg": 0,
"volume_cbm": 0
}
]
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"purchase_order_number": "string",
"seller_address_id": 0,
"seller_address_name": "string",
"incoterm_code": "string",
"loading_port_code": "string",
"loading_port_name": "string",
"ex_factory_date": "2019-08-24",
"order_date": "2019-08-24",
"cargo_ready_date": "2019-08-24",
"purchase_order_lines": [
{
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"booking_lines": [
{
"weight_kg": 0,
"volume_cbm": 0
}
]
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/purchase_orders',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.post 'https://api.shypple.com/public/v1/purchase_orders',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.post('https://api.shypple.com/public/v1/purchase_orders', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/purchase_orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.shypple.com/public/v1/purchase_orders", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.shypple.com/public/v1/purchase_orders', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
POST /v1/purchase_orders
Create a new purchase order.
Body parameter
{
"purchase_order_number": "string",
"seller_address_id": 0,
"seller_address_name": "string",
"incoterm_code": "string",
"loading_port_code": "string",
"loading_port_name": "string",
"ex_factory_date": "2019-08-24",
"order_date": "2019-08-24",
"cargo_ready_date": "2019-08-24",
"purchase_order_lines": [
{
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"booking_lines": [
{
"weight_kg": 0,
"volume_cbm": 0
}
]
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | postV1PurchaseOrders | true | none |
Example responses
201 Response
{
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Create a new purchase order | Public_Entities_PurchaseOrder |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Connections
Operations about Connections
Get a single connection
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/connections/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/connections/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/connections/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/connections/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/connections/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/connections/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/connections/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/connections/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/connections/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/connections/{id}
Get a single connection
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Connection id. |
Example responses
200 Response
{
"organization_id": 0,
"name": "string",
"logo": "string",
"role": "string",
"is_preferred_forwarder": true,
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"last_seen": "2019-08-24T14:15:22Z",
"users": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"url": "string",
"role_code": "string",
"manageable": true,
"addresses": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Get a single connection | Public_Entities_Connection |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 403 | Forbidden | Permissions denied | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Bad request | Public_Entities_Error |
Get all organization connections
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/connections \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/connections HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/connections',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/connections',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/connections',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/connections', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/connections");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/connections", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/connections', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/connections
Get all organization connections
Example responses
200 Response
[
{
"organization_id": 0,
"name": "string",
"logo": "string",
"role": "string",
"is_preferred_forwarder": true,
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"last_seen": "2019-08-24T14:15:22Z",
"users": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"url": "string",
"role_code": "string",
"manageable": true,
"addresses": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Get all organization connections | Inline |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_Connection] | false | none | [Public_Entities_Connection model] |
| » organization_id | integer(int32) | true | none | The unique Shypple identifier |
| » name | string | true | none | Organization name of the Connection |
| » logo | string | false | none | URL of the organization logo |
| » role | string | true | none | The role name of the connection |
| » is_preferred_forwarder | boolean | false | none | When true then the organization is preferred freight forwarder |
| » country | Public_Entities_Country | true | none | Public_Entities_Country model |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» name | string | true | none | The name of the country |
| »» title | string | false | none | DEPRECATED - use attribute "name" instead |
| »» code | string | true | none | The code |
| »» trade_zone | string | true | none | BENELUX for BE/NL/LU, country code for the others. |
| » last_seen | string(date-time) | true | none | The timestamp when this entity was seen last time in ISO 8601 format |
| » users | Public_Entities_User | true | none | none |
| »» id | integer(int32) | true | none | The unique Shypple identifier of the user. |
| »» full_name | string | false | none | Full name of the user. |
| string | true | none | Email of the user. | |
| »» organization_name | string | false | none | Name of the user organization. |
| »» last_active | string(date-time) | true | none | The point in time when this entity was seen last time in ISO 8601 format |
| »» out_of_office_till | string(date-time) | false | none | The date the user is out of office until in ISO 8601 format |
| »» avatar | string | false | none | URL of user avatar |
| » url | string | true | none | The url to this connection |
| » role_code | string | true | none | Code of the organziation role |
| » manageable | boolean | true | none | When true then the organization can be added as a shipment collaborator |
| » addresses | Public_Entities_Address | true | none | Public_Entities_Address model |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» url | string | true | none | The url to this address |
| »» name | string | true | none | The address name |
| »» address | string | false | none | Street street name |
| »» postal_code | string | false | none | The postal code |
| »» city | string | false | none | The city |
| »» country | Public_Entities_Country | true | none | Public_Entities_Country model |
| string | false | none | The email address | |
| »» phone | string | false | none | The phone number |
| »» vat_number | string | false | none | The VAT number |
| »» eori_number | string | false | none | The EORI number |
| »» comment | string | false | none | Additional information about the address. |
| »» default | boolean | false | none | Whether this is the default shipping address. |
| »» connection | Public_Entities_Organization | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | The name |
| »»» prefix | string | true | none | The prefix |
| »»» configured_po_upload | boolean | false | none | Configured Purchase Order tool upload? |
| »»» logo | string | false | none | URL of the organization logo |
| »»» role_code | string | true | none | Code of the organization role |
| »»» default_address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »»» preferred_shipment_role_id | integer(int32) | true | none | ID of the prefered shipment role |
| »»» preferred_forwarder_id | integer(int32) | true | none | ID of preferred freight forwarder connection |
| »»» public_documents | string | false | none | none |
| »» updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| »» ports | [Public_Entities_Port] | false | none | All ports |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | The name |
| »»» code | string | true | none | The 5-character UN Locode identifier of this port |
| »»» display_name | string | false | none | The display name |
| »»» type | string | false | none | The port type |
| »»» country | Public_Entities_Country | false | none | Public_Entities_Country model |
| »»» time_zone | string | false | none | none |
| »» preferred_modalities | [string] | false | none | All preferred modalities |
| »» sla_checkpoints | [Public_Entities_SLACheckpoint] | false | none | All SLA checkpoints |
| »»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»» name | string | true | none | The name of this SLA checkpoint. |
| »»» dt_days | integer(int32) | true | none | The delta of days (negative is in the past). |
| »»» has_info_requests | boolean | false | none | none |
| »»» owner | Public_Entities_User | true | none | none |
| »»» sla_checkpoint_type | Public_Entities_SLACheckpointType | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»»» code | string | true | none | The code of this SLA checkpoint. |
| »»»» name | string | true | none | The name of this SLA checkpoint. |
| »»» sla_checkpoint_value | Public_Entities_SLACheckpointValue | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» date_field | string | true | none | The name of the date field |
| »»»» description | string | true | none | The description of the date field |
| »»» created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| »»» sla_checkpoint_addresses | Public_Entities_SLACheckpointAddress | false | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»»» automated_alert | boolean | true | none | Indicates if alerts for this address are enabled for the SLA checkpoint. |
| »»»» address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »»» due_date_message_status | Public_Entities_DueDateMessageStatus | false | none | none |
| »»»» due_date | string(date) | false | none | The due date for the SLA checkpoint belonging to the purchase order. |
| »»»» message_status | string | false | none | The message status of the SLA checkpoint belonging to the purchase order. |
| »» full_text | string | false | none | Full text of address |
| » preferred_shipment_role_id | string | true | none | The ID of preferred shipment role of this connection. |
Shipments
Retrieve information about your shipments.
Create 3PL shipment
Code samples
# You can also use wget
curl -X POST https://api.shypple.com/public/v1/shipments \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
POST https://api.shypple.com/public/v1/shipments HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"collaborators": [
{
"organization_id": 0,
"role_codes": [
"third_party_shipment"
]
}
],
"customer_role": "third_party_shipment",
"modality": "sea",
"load_type": "lcl",
"origin_location_type": "address",
"origin_location": "string",
"destination_location_type": "address",
"destination_location": "string",
"estimated_departure_date": "2019-08-24T14:15:22Z",
"allow_create_containers_from_tracking": false,
"dangerous_goods": false,
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"shypple_carrier_id": 0,
"carrier_scac_code": "string",
"services": {
"pickup": true,
"export_customs": true,
"origin_port": true,
"freight": true,
"destination_port": true,
"import_customs": true,
"delivery": true
},
"insurance": true,
"cif_value": 0,
"incoterm": "EXW",
"product_group_code": "string",
"containers": [
{
"container_type_iso": "22G0",
"number": "string",
"seal_number": "string",
"shared_reference": "string"
}
],
"cargo_attributes": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 0,
"goods_description": "string",
"package_type": "BG",
"stackable": true
}
],
"requested_air_tt": [
"fast"
],
"customer_organization_id": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"collaborators": [
{
"organization_id": 0,
"role_codes": [
"third_party_shipment"
]
}
],
"customer_role": "third_party_shipment",
"modality": "sea",
"load_type": "lcl",
"origin_location_type": "address",
"origin_location": "string",
"destination_location_type": "address",
"destination_location": "string",
"estimated_departure_date": "2019-08-24T14:15:22Z",
"allow_create_containers_from_tracking": false,
"dangerous_goods": false,
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"shypple_carrier_id": 0,
"carrier_scac_code": "string",
"services": {
"pickup": true,
"export_customs": true,
"origin_port": true,
"freight": true,
"destination_port": true,
"import_customs": true,
"delivery": true
},
"insurance": true,
"cif_value": 0,
"incoterm": "EXW",
"product_group_code": "string",
"containers": [
{
"container_type_iso": "22G0",
"number": "string",
"seal_number": "string",
"shared_reference": "string"
}
],
"cargo_attributes": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 0,
"goods_description": "string",
"package_type": "BG",
"stackable": true
}
],
"requested_air_tt": [
"fast"
],
"customer_organization_id": 0
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.post 'https://api.shypple.com/public/v1/shipments',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.post('https://api.shypple.com/public/v1/shipments', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/shipments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.shypple.com/public/v1/shipments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.shypple.com/public/v1/shipments', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
POST /v1/shipments
Returns a 404 error if no shipment can be found with the provided ID. Returns a 400 error if the provided ID is not an integer.
Body parameter
{
"collaborators": [
{
"organization_id": 0,
"role_codes": [
"third_party_shipment"
]
}
],
"customer_role": "third_party_shipment",
"modality": "sea",
"load_type": "lcl",
"origin_location_type": "address",
"origin_location": "string",
"destination_location_type": "address",
"destination_location": "string",
"estimated_departure_date": "2019-08-24T14:15:22Z",
"allow_create_containers_from_tracking": false,
"dangerous_goods": false,
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"shypple_carrier_id": 0,
"carrier_scac_code": "string",
"services": {
"pickup": true,
"export_customs": true,
"origin_port": true,
"freight": true,
"destination_port": true,
"import_customs": true,
"delivery": true
},
"insurance": true,
"cif_value": 0,
"incoterm": "EXW",
"product_group_code": "string",
"containers": [
{
"container_type_iso": "22G0",
"number": "string",
"seal_number": "string",
"shared_reference": "string"
}
],
"cargo_attributes": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 0,
"goods_description": "string",
"package_type": "BG",
"stackable": true
}
],
"requested_air_tt": [
"fast"
],
"customer_organization_id": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | postV1Shipments | true | none |
Example responses
201 Response
{
"id": 0,
"url": "string",
"public_url": "string",
"type": "string",
"load_type": "string",
"title": "string",
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"status_text": "string",
"status_code": "string",
"customs_documentation_complete": {},
"estimated_departure_date": "2019-08-24",
"actual_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"actual_arrival_date": "2019-08-24",
"voyage_no": "string",
"pickup_time_from": "2019-08-24T14:15:22Z",
"pickup_time_until": "2019-08-24T14:15:22Z",
"pickup_address_text": "string",
"delivery_time_from": "2019-08-24T14:15:22Z",
"delivery_time_until": "2019-08-24T14:15:22Z",
"delivery_address_text": "string",
"transportation_costs": "string",
"duty_tax_costs": "string",
"costs_currency": {},
"total_cargo_chargeable_weight_kg": 0,
"carrier": {
"id": 0,
"name": "string",
"scac": "string",
"carrier_alliance_name": "string",
"carrier_alliance_code": "string",
"preferred_tracking_key": "string",
"ocean_insights_coverage": "string",
"carrier_type": "string"
},
"product_group": {
"id": 0,
"name": "string",
"code": "string"
},
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"containers": {
"id": 0,
"type": "string",
"number": "string",
"seal_number": "string",
"shared_reference": "string",
"total_cargo_weight_kg": 0,
"cargo": {
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
},
"documents": {
"id": 0,
"type": "string",
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"document_manageable": true,
"viewable_by": [
{
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
]
},
"bookings": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"changed_since": "2019-08-24T14:15:22Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Create 3PL shipment | Public_Entities_Shipment |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
List all shipments
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/shipments \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/shipments HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/shipments',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/shipments', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/shipments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/shipments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/shipments', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/shipments
The shipments are returned in order of last updated, i.e. the first
shipment in the list is the last modified shipment.
The result is paginated, use the url in next to get the next page.
If next is null you have reached the last page.
It is recommended to keep track of the changed_since field of the first shipment and
use this in the changed_since parameter to get all shipments that were changed
since you last checked.
For example, if the first shipment in the list has "changed_since": "2019-05-31T09:58:47.659+02:00"
then your next request should be /shipments?changed_since=2019-05-31T09%3A58%3A47.659%2B02%3A00
(if you get an error please check that you have properly used URL encoding according to RFC3986).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | integer(int32) | false | Page number |
| per_page | query | integer(int32) | false | Number of results per page |
| changed_since | query | string(date-time) | false | Get only the shipments changed since this point in time (in ISO 8601 format) |
Example responses
200 Response
{
"url": "string",
"next": "string",
"first": "string",
"last": "string",
"shipments": [
{
"id": 0,
"url": "string",
"public_url": "string",
"load_type": "string",
"type": "string",
"shipment_type": "string",
"title": "string",
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"closing_datetime": "2019-08-24T14:15:22Z",
"closing_datetime_status": "string",
"pickup_available_from": "2019-08-24T14:15:22Z",
"pickup_available_to": "2019-08-24T14:15:22Z",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z",
"delivery_available_from": "2019-08-24T14:15:22Z",
"shipment_phase": "string",
"status": "string",
"status_text": "string",
"customs_documentation_complete": {},
"estimated_departure_date": "2019-08-24",
"actual_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"actual_arrival_date": "2019-08-24",
"transportation_costs": "string",
"duty_tax_costs": "string",
"costs_currency": {},
"total_costs_per_cbm": "string",
"total_costs_per_teu": "string",
"total_cargo_chargeable_weight_kg": 0,
"carrier": {
"id": 0,
"name": "string",
"scac": "string",
"carrier_alliance_name": "string",
"carrier_alliance_code": "string",
"preferred_tracking_key": "string",
"ocean_insights_coverage": "string",
"carrier_type": "string"
},
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"latitude": "string",
"longitude": "string",
"vessel": {
"id": 0,
"name": "string",
"imo": 0
},
"voyage_no": "string",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"bookings": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"incoterm": "string",
"product_group": {
"id": 0,
"name": "string",
"code": "string"
},
"has_reefer_containers": "string",
"total_emission_gram": 0,
"total_ttw_emission_gram": 0,
"total_wtt_emission_gram": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"changed_since": "2019-08-24T14:15:22Z",
"temperature_setting": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List all shipments | Public_Entities_ShipmentList |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
Create OneView shipment
Code samples
# You can also use wget
curl -X POST https://api.shypple.com/public/v1/shipments/oneview \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
POST https://api.shypple.com/public/v1/shipments/oneview HTTP/1.1
Host: api.shypple.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
"collaborators": [
{
"organization_id": 0,
"role_codes": [
"third_party_shipment"
]
}
],
"customer_role": "third_party_shipment",
"bl_number": "string",
"booking_number": "string",
"container_number": "string",
"reference": "string",
"shypple_carrier_id": 0,
"carrier_scac_code": "string",
"product_group_code": "string",
"customer_organization_id": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/oneview',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"collaborators": [
{
"organization_id": 0,
"role_codes": [
"third_party_shipment"
]
}
],
"customer_role": "third_party_shipment",
"bl_number": "string",
"booking_number": "string",
"container_number": "string",
"reference": "string",
"shypple_carrier_id": 0,
"carrier_scac_code": "string",
"product_group_code": "string",
"customer_organization_id": 0
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/oneview',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.post 'https://api.shypple.com/public/v1/shipments/oneview',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.post('https://api.shypple.com/public/v1/shipments/oneview', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/shipments/oneview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.shypple.com/public/v1/shipments/oneview", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.shypple.com/public/v1/shipments/oneview', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
POST /v1/shipments/oneview
Returns a 404 error if no shipment can be found with the provided ID. Returns a 400 error if the provided ID is not an integer. Returns a 422 error if parameters are not valid.
Body parameter
{
"collaborators": [
{
"organization_id": 0,
"role_codes": [
"third_party_shipment"
]
}
],
"customer_role": "third_party_shipment",
"bl_number": "string",
"booking_number": "string",
"container_number": "string",
"reference": "string",
"shypple_carrier_id": 0,
"carrier_scac_code": "string",
"product_group_code": "string",
"customer_organization_id": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | postV1ShipmentsOneview | true | none |
Example responses
201 Response
{
"id": 0,
"url": "string",
"public_url": "string",
"type": "string",
"load_type": "string",
"title": "string",
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"status_text": "string",
"status_code": "string",
"customs_documentation_complete": {},
"estimated_departure_date": "2019-08-24",
"actual_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"actual_arrival_date": "2019-08-24",
"voyage_no": "string",
"pickup_time_from": "2019-08-24T14:15:22Z",
"pickup_time_until": "2019-08-24T14:15:22Z",
"pickup_address_text": "string",
"delivery_time_from": "2019-08-24T14:15:22Z",
"delivery_time_until": "2019-08-24T14:15:22Z",
"delivery_address_text": "string",
"transportation_costs": "string",
"duty_tax_costs": "string",
"costs_currency": {},
"total_cargo_chargeable_weight_kg": 0,
"carrier": {
"id": 0,
"name": "string",
"scac": "string",
"carrier_alliance_name": "string",
"carrier_alliance_code": "string",
"preferred_tracking_key": "string",
"ocean_insights_coverage": "string",
"carrier_type": "string"
},
"product_group": {
"id": 0,
"name": "string",
"code": "string"
},
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"containers": {
"id": 0,
"type": "string",
"number": "string",
"seal_number": "string",
"shared_reference": "string",
"total_cargo_weight_kg": 0,
"cargo": {
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
},
"documents": {
"id": 0,
"type": "string",
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"document_manageable": true,
"viewable_by": [
{
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
]
},
"bookings": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"changed_since": "2019-08-24T14:15:22Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Create OneView shipment | Public_Entities_Shipment |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
| 422 | Unprocessable Entity | Unprocessable Entity | Public_Entities_Error |
Get a shipment by ID
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/shipments/{id} \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/shipments/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/shipments/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/shipments/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/shipments/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/shipments/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/shipments/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/shipments/{id}
Returns a 404 error if no shipment can be found with the provided ID. Returns a 400 error if the provided ID is not an integer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Shipment id. |
Example responses
200 Response
{
"id": 0,
"url": "string",
"public_url": "string",
"type": "string",
"load_type": "string",
"title": "string",
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"status_text": "string",
"status_code": "string",
"customs_documentation_complete": {},
"estimated_departure_date": "2019-08-24",
"actual_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"actual_arrival_date": "2019-08-24",
"voyage_no": "string",
"pickup_time_from": "2019-08-24T14:15:22Z",
"pickup_time_until": "2019-08-24T14:15:22Z",
"pickup_address_text": "string",
"delivery_time_from": "2019-08-24T14:15:22Z",
"delivery_time_until": "2019-08-24T14:15:22Z",
"delivery_address_text": "string",
"transportation_costs": "string",
"duty_tax_costs": "string",
"costs_currency": {},
"total_cargo_chargeable_weight_kg": 0,
"carrier": {
"id": 0,
"name": "string",
"scac": "string",
"carrier_alliance_name": "string",
"carrier_alliance_code": "string",
"preferred_tracking_key": "string",
"ocean_insights_coverage": "string",
"carrier_type": "string"
},
"product_group": {
"id": 0,
"name": "string",
"code": "string"
},
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"containers": {
"id": 0,
"type": "string",
"number": "string",
"seal_number": "string",
"shared_reference": "string",
"total_cargo_weight_kg": 0,
"cargo": {
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
},
"documents": {
"id": 0,
"type": "string",
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"document_manageable": true,
"viewable_by": [
{
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
]
},
"bookings": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"changed_since": "2019-08-24T14:15:22Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Return a single shipment | Public_Entities_Shipment |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
Get a list of containers by shipment ID
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/shipments/{id}/containers \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/shipments/{id}/containers HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/{id}/containers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/{id}/containers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/shipments/{id}/containers',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/shipments/{id}/containers', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/shipments/{id}/containers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/shipments/{id}/containers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/shipments/{id}/containers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/shipments/{id}/containers
Returns a 404 error if no shipment can be found with the provided ID. Returns a 400 error if the provided ID is not an integer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Shipment id. |
Example responses
200 Response
[
{
"id": 0,
"status": "string",
"container_event_exceptions": [
"string"
],
"shared_reference": "string",
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"number": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"seal_number": "string",
"type": "string",
"devanning_date": "2019-08-24",
"discharged_at": "2019-08-24T14:15:22Z",
"total_cargo_weight_kg": 0,
"total_volume_cbm": 0,
"packages": 0,
"hs_codes": [
{
"id": 0,
"goods_code": "string",
"description": "string",
"notes": "string"
}
],
"cargo": [
{
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
],
"inland_transports": [
{
"id": 0,
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"shipment_details": "string",
"modality": "string",
"carrier": "string",
"cargo_weight_kg": "string",
"service": "string",
"status": "string",
"transporter_status": "string",
"pickup_delivery_time": "2019-08-24T14:15:22Z",
"closing_time": "2019-08-24T14:15:22Z",
"pickup_delivery_time_editable": true,
"inland_transport_addresses": [
{
"id": 0,
"inland_transport": {
"id": 0,
"service": "string",
"url": "string"
},
"pickup_delivery": true,
"reference": "string",
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"datetime_status": "string",
"datetime_manageable?": {},
"url": "string",
"name": "string",
"address_id": 0,
"address_type": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"comment": "string",
"vat_number": "string",
"eori_number": "string",
"latitude": 0,
"longitude": 0
}
],
"url": "string"
}
],
"url": "string",
"container_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"event_type_description": "string",
"template_variables": {},
"exception": "string"
}
],
"milestones": "string",
"temperature": "string",
"humidity": "string",
"vents_open": true,
"drains_open": true,
"co2_regulation": "string",
"ventilation": "string",
"comments": "string",
"equipment_controlled_atmosphere": true,
"tare_weight_kg": 0
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a list of containers | Inline |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_ContainerV2] | false | none | [Public_Entities_ContainerV2 model] |
| » id | integer(int32) | true | none | The unique identifier of the container |
| » status | string | false | none | Container status if being tracked by portbase |
| » container_event_exceptions | [string] | false | none | Exception event types |
| » shared_reference | string | false | none | The container's shared reference |
| » pod_customs_documents_present | boolean | false | none | True if documents are present at discharge port |
| » pod_customs_inspection_status | string | false | none | Customs inspection status if container is notified or released from customs checks |
| » pod_customs_inspection_type | string | false | none | The type of customs check that can be expected |
| » number | string | false | none | Container number |
| » shipment | Public_Entities_ShipmentShort | true | none | none |
| »» id | integer(int32) | true | none | The unique Shypple identifier for this shipment. |
| »» reference | string | false | none | Your reference for this shipment |
| »» our_reference | string | false | none | Shypple's reference for this shipment |
| »» internal_reference | string | false | none | Shypple's reference for current organization |
| »» url | string | true | none | The url to this shipment. |
| »» public_shipment_link | string | false | none | The url to this shipment. |
| »» port_pair | Public_Entities_PortPair | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» loading_port | Public_Entities_Port | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» name | string | true | none | The name |
| »»»» code | string | true | none | The 5-character UN Locode identifier of this port |
| »»»» display_name | string | false | none | The display name |
| »»»» type | string | false | none | The port type |
| »»»» country | Public_Entities_Country | false | none | Public_Entities_Country model |
| »»»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»»» name | string | true | none | The name of the country |
| »»»»» title | string | false | none | DEPRECATED - use attribute "name" instead |
| »»»»» code | string | true | none | The code |
| »»»»» trade_zone | string | true | none | BENELUX for BE/NL/LU, country code for the others. |
| »»»» time_zone | string | false | none | none |
| »»» discharge_port | Public_Entities_Port | true | none | none |
| »»» tradelane | string | false | none | none |
| »» estimated_departure_date | string(date) | true | none | Estimated Departure Date |
| »» estimated_arrival_date | string(date) | true | none | Estimated Arrival Date |
| »» destination_demurrage_starting_from | string(date-time) | false | none | none |
| » seal_number | string | false | none | The seal_number for the container |
| » type | string | true | none | The type code of container: 20_ft, 40_ft, 40_ft_hc, 45_ft or unknown |
| » devanning_date | string(date) | false | none | Date on which shipment will be devanned or (deconsolidated) at the Container Freight Station. Only applicable for shipments with type = LCL |
| » discharged_at | string(date-time) | false | none | Container discharge time |
| » total_cargo_weight_kg | integer(int32) | false | none | Total weight of the cargo in this container in kilograms |
| » total_volume_cbm | integer(int32) | false | none | Total volume of the cargo in this container in cbm |
| » packages | integer(int32) | false | none | The total number of packages in this container |
| » hs_codes | [Public_Entities_ContainerHSCode] | false | none | All container HS codes |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» goods_code | string | false | none | The goods code |
| »» description | string | false | none | The description |
| »» notes | string | false | none | BENELUX for BE/NL/LU, country code for the others. |
| » cargo | [Public_Entities_Cargo] | false | none | All cargos |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» url | string | true | none | The url to this cargo. |
| »» container | Public_Entities_ContainerShort | true | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier for this container. |
| »»» status | string | false | none | Container status if being tracked by portbase |
| »»» number | string | false | none | The container number |
| »»» url | string | true | none | The url to this container. |
| »»» type | string | true | none | The type of container: 20_ft, 40_ft, 40_ft_hc, 45_ft or unknown |
| »»» type_name | string | false | none | The type of container: 20 FT, 40 FY, 40 FT HC, 45 FT or Unknown |
| »»» container_index | string | true | none | The container index name |
| »»» container_event_exceptions | [string] | false | none | Exception event types |
| »»» pod_customs_documents_present | boolean | false | none | True if documents are present at discharge port |
| »»» pod_customs_inspection_status | string | false | none | Customs inspection status if container is notified or released from customs checks |
| »»» pod_customs_inspection_type | string | false | none | The type of customs check that can be expected |
| »»» discharged_at | string(date-time) | false | none | Container discharge time |
| »»» shared_reference | string | false | none | Container shared reference |
| »» goods_description | string | false | none | The goods description |
| »» stackable | boolean | true | none | Is the cargo stackable? |
| »» quantity | integer(int32) | true | none | The quantity |
| »» total_weight_kg | number(float) | true | none | The total weight in kilograms |
| »» length_mm | integer(int32) | false | none | The length in millimeters |
| »» width_mm | integer(int32) | false | none | The width in millimeters |
| »» height_mm | integer(int32) | false | none | The height in millimeters |
| »» volume_cbm | number(float) | true | none | Volume of the cargo in cubic meters |
| »» marks_and_numbers | string | false | none | The marks and numbers |
| »» package_type | Public_Entities_PackageTypeShort | true | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier for this package type. |
| »»» code | string | true | none | The code |
| »»» name | string | true | none | The name |
| »» package_type_name | string | false | none | The package type name |
| »» package_type_code | string | false | none | The package type code |
| »» created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
| »» booking_id | integer(int32) | false | none | The booking identifier |
| »» slac | integer(int32) | false | none | The SLAC |
| » inland_transports | [Public_Entities_InlandTransport] | false | none | All inland transports |
| »» id | integer(int32) | true | none | The unique Shypple identifier for the inland transport |
| »» container | Public_Entities_ContainerShort | true | none | none |
| »» shipment | Public_Entities_ShipmentShort | true | none | none |
| »» shipment_details | string | true | none | Details about the shipment |
| »» modality | string | true | none | The modality of this Inland Transport: road, barge or rail |
| »» carrier | string | false | none | The name of the carrier for the shipment |
| »» cargo_weight_kg | string | false | none | The total weight of the cargo in kg |
| »» service | string | true | none | The service of this Inland Transport: pickup or delivery |
| »» status | string | true | none | The status of this Inland Transport: estimated, proposed, requested or confirmed |
| »» transporter_status | string | true | none | The transporter status of this Inland Transport: open, accepted or completed |
| »» pickup_delivery_time | string(date-time) | false | none | The time of pickup or delivery, in ISO 8601 format |
| »» closing_time | string(date-time) | false | none | The closing time of pickup or delivery, in ISO 8601 format |
| »» pickup_delivery_time_editable | boolean | true | none | Whether the pickup_delivery_time attribute is editable |
| »» inland_transport_addresses | [Public_Entities_InlandTransportAddress] | false | none | All inland transport addresses |
| »»» id | integer(int32) | true | none | The unique Shypple identifier for this inland transport address |
| »»» inland_transport | Public_Entities_InlandTransportShort | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier for this inland transport. |
| »»»» service | string | true | none | The service name |
| »»»» url | string | true | none | The url to this inland transport. |
| »»» pickup_delivery | boolean | true | none | Is pickup delivery address? |
| »»» reference | string | false | none | The reference |
| »»» datetime_from | string(date-time) | false | none | The formatted from-datetime |
| »»» datetime_to | string(date-time) | false | none | The formatted to-datetime |
| »»» datetime_status | string | true | none | The status of the date time above: estimated, requested, proposed, confirmed |
| »»» datetime_manageable? | object | false | none | Is datetime manageable? |
| »»» url | string | true | none | The url to this inland transport address |
| »»» name | string | false | none | The name |
| »»» address_id | integer(int32) | false | none | The identifier of the address |
| »»» address_type | string | false | none | One of the address types. |
| »»» address | string | false | none | Street address. |
| »»» postal_code | string | false | none | The postal code |
| »»» city | string | false | none | The city name |
| »»» country | Public_Entities_Country | false | none | Public_Entities_Country model |
| »»» comment | string | false | none | The comment |
| »»» vat_number | string | false | none | The VAT number |
| »»» eori_number | string | false | none | The EORI number |
| »»» latitude | number(float) | false | none | The GPS latitude coordinate |
| »»» longitude | number(float) | false | none | The GPS longitude coordinate |
| »» url | string | true | none | The url to this inland transport |
| » url | string | true | none | The url to this container |
| » container_events | [Public_Entities_ContainerEvent] | false | none | The container event ordered from new to old |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
| »» user | Public_Entities_User | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier of the user. |
| »»» full_name | string | false | none | Full name of the user. |
| string | true | none | Email of the user. | |
| »»» organization_name | string | false | none | Name of the user organization. |
| »»» last_active | string(date-time) | true | none | The point in time when this entity was seen last time in ISO 8601 format |
| »»» out_of_office_till | string(date-time) | false | none | The date the user is out of office until in ISO 8601 format |
| »»» avatar | string | false | none | URL of user avatar |
| »» template_name | string | false | none | The template name |
| »» event_type_description | string | false | none | Human description of event |
| »» template_variables | object | false | none | All template variables |
| »» exception | string | false | none | Is true when container event is an exception |
| » milestones | string | false | none | Public::Entities::Milestone |
| » temperature | string | false | none | Temperature value / range. |
| » humidity | string | false | none | Humidity of the container. |
| » vents_open | boolean | false | none | none |
| » drains_open | boolean | false | none | none |
| » co2_regulation | string | false | none | none |
| » ventilation | string | false | none | none |
| » comments | string | false | none | none |
| » equipment_controlled_atmosphere | boolean | false | none | Whether it is controlled atmophere or not. |
| » tare_weight_kg | integer(int32) | false | none | The tare weight of the container in kilograms |
Get a list of collaborators by shipment ID
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/shipments/{id}/collaborators \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/shipments/{id}/collaborators HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/{id}/collaborators',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/{id}/collaborators',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/shipments/{id}/collaborators',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/shipments/{id}/collaborators', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/shipments/{id}/collaborators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/shipments/{id}/collaborators", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/shipments/{id}/collaborators', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/shipments/{id}/collaborators
Returns a 404 error if no shipment can be found with the provided ID. Returns a 400 error if the provided ID is not an integer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Shipment id. |
Example responses
200 Response
[
{
"id": 0,
"organization_id": 0,
"flagged_at": "2019-08-24T14:15:22Z",
"name": "string",
"logo": "string",
"organization_role_code": "string",
"organization_role_name": "string",
"manageable": true,
"roles": [
null
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a list of shipment collaborators | Inline |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_ShipmentOrganization] | false | none | [Public_Entities_ShipmentOrganization model] |
| » id | integer(int32) | true | none | The unique Shypple identifier |
| » organization_id | integer(int32) | true | none | The unique Shypple identifier |
| » flagged_at | string(date-time) | true | none | Datetime when shipment was flagged for organization |
| » name | string | true | none | Name of organization |
| » logo | string | true | none | URL of the organization logo |
| » organization_role_code | string | true | none | Code of the organziation role |
| » organization_role_name | string | true | none | Name of the organziation role |
| » manageable | boolean | true | none | Is manageable by current user orgnaization |
| » roles | [any] | true | none | Array of shipment organization shipment roles |
Get a list of bookings by shipment ID
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/shipments/{id}/bookings \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/shipments/{id}/bookings HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/{id}/bookings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipments/{id}/bookings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/shipments/{id}/bookings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/shipments/{id}/bookings', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/shipments/{id}/bookings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/shipments/{id}/bookings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/shipments/{id}/bookings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/shipments/{id}/bookings
Returns a 404 error if no shipment can be found with the provided ID. Returns a 400 error if the provided ID is not an integer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Shipment id. |
Example responses
200 Response
[
{
"id": 0,
"url": "string",
"booking_reference": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"cargo_ready_date": "2019-08-24",
"house_bl": "string",
"incoterm": "string",
"commercial_invoice_and_packing_list_uploaded": true,
"booking_parties_information_complete": true,
"consignee_as_notify_party": true,
"shipment_documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"shipper": {},
"consignee": {},
"notify_party": {},
"booking_events": {
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"template_variables": {}
},
"purchase_orders": {
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
},
"booking_index": "string",
"milestones": {
"id": 0,
"name": "string",
"code": "string",
"reached": true,
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"status": "string",
"booking_level": true,
"container_level": true,
"tasks": {
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a list of bookings | Inline |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_Booking] | false | none | [Public_Entities_Booking model] |
| » id | integer(int32) | true | none | The unique identifier of the booking |
| » url | string | true | none | The url to this booking |
| » booking_reference | string | false | none | The booking reference for the booking |
| » shipment | Public_Entities_ShipmentShort | false | none | none |
| »» id | integer(int32) | true | none | The unique Shypple identifier for this shipment. |
| »» reference | string | false | none | Your reference for this shipment |
| »» our_reference | string | false | none | Shypple's reference for this shipment |
| »» internal_reference | string | false | none | Shypple's reference for current organization |
| »» url | string | true | none | The url to this shipment. |
| »» public_shipment_link | string | false | none | The url to this shipment. |
| »» port_pair | Public_Entities_PortPair | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» loading_port | Public_Entities_Port | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» name | string | true | none | The name |
| »»»» code | string | true | none | The 5-character UN Locode identifier of this port |
| »»»» display_name | string | false | none | The display name |
| »»»» type | string | false | none | The port type |
| »»»» country | Public_Entities_Country | false | none | Public_Entities_Country model |
| »»»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»»» name | string | true | none | The name of the country |
| »»»»» title | string | false | none | DEPRECATED - use attribute "name" instead |
| »»»»» code | string | true | none | The code |
| »»»»» trade_zone | string | true | none | BENELUX for BE/NL/LU, country code for the others. |
| »»»» time_zone | string | false | none | none |
| »»» discharge_port | Public_Entities_Port | true | none | none |
| »»» tradelane | string | false | none | none |
| »» estimated_departure_date | string(date) | true | none | Estimated Departure Date |
| »» estimated_arrival_date | string(date) | true | none | Estimated Arrival Date |
| »» destination_demurrage_starting_from | string(date-time) | false | none | none |
| » cargo_ready_date | string(date) | false | none | Cargo ready date |
| » house_bl | string | false | none | House BL |
| » incoterm | string | false | none | Incoterm |
| » commercial_invoice_and_packing_list_uploaded | boolean | true | none | customs_documentation_complete |
| » booking_parties_information_complete | boolean | true | none | booking_parties_information_complete |
| » consignee_as_notify_party | boolean | true | none | consignee_as_notify_party |
| » shipment_documents | Public_Entities_ShipmentDocumentV2 | false | none | none |
| »» id | integer(int32) | true | none | The unique Shypple identifier of the document. |
| »» types | [Public_Entities_DocumentType] | false | none | All document_types |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | Name of document type. |
| »»» code | string | true | none | Code of document type. |
| »»» shipment_level | boolean | true | none | Can be assigned to shipment. |
| »»» container_level | boolean | true | none | Can be assigned to container. |
| »»» booking_level | boolean | true | none | Can be assigned to booking. |
| »»» organization_level | boolean | true | none | Can be assigned to organization. |
| »»» created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
| »» original_filename | string | true | none | The original file name when it was uploaded. |
| »» description | string | false | none | Optional extra description about the contents of the file. |
| »» url | string | true | none | Download URL. Make sure you follow redirects. |
| »» download_url | string | false | none | Download URL. Direct link to download document. |
| »» created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| »» containers | Public_Entities_ContainerShort | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier for this container. |
| »»» status | string | false | none | Container status if being tracked by portbase |
| »»» number | string | false | none | The container number |
| »»» url | string | true | none | The url to this container. |
| »»» type | string | true | none | The type of container: 20_ft, 40_ft, 40_ft_hc, 45_ft or unknown |
| »»» type_name | string | false | none | The type of container: 20 FT, 40 FY, 40 FT HC, 45 FT or Unknown |
| »»» container_index | string | true | none | The container index name |
| »»» container_event_exceptions | [string] | false | none | Exception event types |
| »»» pod_customs_documents_present | boolean | false | none | True if documents are present at discharge port |
| »»» pod_customs_inspection_status | string | false | none | Customs inspection status if container is notified or released from customs checks |
| »»» pod_customs_inspection_type | string | false | none | The type of customs check that can be expected |
| »»» discharged_at | string(date-time) | false | none | Container discharge time |
| »»» shared_reference | string | false | none | Container shared reference |
| »» uploaded_by | Public_Entities_User | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier of the user. |
| »»» full_name | string | false | none | Full name of the user. |
| string | true | none | Email of the user. | |
| »»» organization_name | string | false | none | Name of the user organization. |
| »»» last_active | string(date-time) | true | none | The point in time when this entity was seen last time in ISO 8601 format |
| »»» out_of_office_till | string(date-time) | false | none | The date the user is out of office until in ISO 8601 format |
| »»» avatar | string | false | none | URL of user avatar |
| »» booking | Public_Entities_BookingShort | false | none | none |
| »»» id | integer(int32) | true | none | The unique identifier of the booking. |
| »»» url | string | true | none | The url to this booking. |
| »»» booking_reference | string | false | none | Booking reference` for the booking. |
| »»» booking_index | string | false | none | Booking index in shipment. |
| »»» shipper_name | string | false | none | Name of the shipper organization. |
| »»» consignee_name | string | false | none | Name of the consignee organization. |
| »» shipment | Public_Entities_ShipmentShort | false | none | none |
| »» document_manageable | boolean | false | none | Document manageable by user role. |
| »» viewable_by | Public_Entities_Organization | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | The name |
| »»» prefix | string | true | none | The prefix |
| »»» configured_po_upload | boolean | false | none | Configured Purchase Order tool upload? |
| »»» logo | string | false | none | URL of the organization logo |
| »»» role_code | string | true | none | Code of the organization role |
| »»» default_address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» url | string | true | none | The url to this address |
| »»»» name | string | true | none | The address name |
| »»»» address | string | false | none | Street street name |
| »»»» postal_code | string | false | none | The postal code |
| »»»» city | string | false | none | The city |
| »»»» country | Public_Entities_Country | true | none | Public_Entities_Country model |
| string | false | none | The email address | |
| »»»» phone | string | false | none | The phone number |
| »»»» vat_number | string | false | none | The VAT number |
| »»»» eori_number | string | false | none | The EORI number |
| »»»» comment | string | false | none | Additional information about the address. |
| »»»» default | boolean | false | none | Whether this is the default shipping address. |
| »»»» connection | Public_Entities_Organization | false | none | none |
| »»»» updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| »»»» ports | [Public_Entities_Port] | false | none | All ports |
| »»»» preferred_modalities | [string] | false | none | All preferred modalities |
| »»»» sla_checkpoints | [Public_Entities_SLACheckpoint] | false | none | All SLA checkpoints |
| »»»»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»»»» name | string | true | none | The name of this SLA checkpoint. |
| »»»»» dt_days | integer(int32) | true | none | The delta of days (negative is in the past). |
| »»»»» has_info_requests | boolean | false | none | none |
| »»»»» owner | Public_Entities_User | true | none | none |
| »»»»» sla_checkpoint_type | Public_Entities_SLACheckpointType | true | none | none |
| »»»»»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»»»»» code | string | true | none | The code of this SLA checkpoint. |
| »»»»»» name | string | true | none | The name of this SLA checkpoint. |
| »»»»» sla_checkpoint_value | Public_Entities_SLACheckpointValue | true | none | none |
| »»»»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»»»» date_field | string | true | none | The name of the date field |
| »»»»»» description | string | true | none | The description of the date field |
| »»»»» created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| »»»»» sla_checkpoint_addresses | Public_Entities_SLACheckpointAddress | false | none | none |
| »»»»»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»»»»» automated_alert | boolean | true | none | Indicates if alerts for this address are enabled for the SLA checkpoint. |
| »»»»»» address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »»»»» due_date_message_status | Public_Entities_DueDateMessageStatus | false | none | none |
| »»»»»» due_date | string(date) | false | none | The due date for the SLA checkpoint belonging to the purchase order. |
| »»»»»» message_status | string | false | none | The message status of the SLA checkpoint belonging to the purchase order. |
| »»»» full_text | string | false | none | Full text of address |
| »»» preferred_shipment_role_id | integer(int32) | true | none | ID of the prefered shipment role |
| »»» preferred_forwarder_id | integer(int32) | true | none | ID of preferred freight forwarder connection |
| »»» public_documents | string | false | none | none |
| » shipper | object | false | none | The shipper |
| » consignee | object | false | none | The consignee |
| » notify_party | object | false | none | The notify party |
| » booking_events | Public_Entities_BookingEvent | false | none | none |
| »» created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
| »» user | Public_Entities_User | false | none | none |
| »» template_name | string | false | none | The template name |
| »» template_variables | object | false | none | All template_variables |
| » purchase_orders | Public_Entities_PurchaseOrder | false | none | Public_Entities_PurchaseOrder model |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» url | string | true | none | The url to this purchase order |
| »» purchase_order_number | string | true | none | The purchase order's company-unique identifier |
| »» seller | object | true | none | The seller address and organization |
| »»» address | Public_Entities_AddressSeller | false | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» url | string | true | none | The url to this address |
| »»»» name | string | true | none | The name |
| »»»» address | string | false | none | Street address. |
| »»»» postal_code | string | false | none | The postal code |
| »»»» city | string | false | none | The city |
| »»»» country | Public_Entities_Country | true | none | Public_Entities_Country model |
| string | false | none | The email address | |
| »»»» phone | string | false | none | The phone number |
| »»» organization | Public_Entities_OrganizationShort | false | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» name | string | true | none | The name of the organization |
| »»»» preferred_shipment_role_id | string | true | none | The role name of the preferred shipment role |
| »»»» role_code | string | true | none | Code of the organziation role |
| »»»» manageable | boolean | true | none | When true then the organization can be added as a shipment collaborator |
| »»»» logo | string | false | none | URL of the organization logo |
| »»»» role | string | true | none | The role name of the connection |
| »»»» default_address | Public_Entities_AddressShort | true | none | none |
| »»»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»»» url | string | true | none | The url to this address |
| »»»»» name | string | true | none | The address name |
| »»»»» address | string | false | none | Street street name |
| »»»»» postal_code | string | false | none | The postal code |
| »»»»» city | string | false | none | The city |
| »»»»» country | Public_Entities_Country | true | none | Public_Entities_Country model |
| string | false | none | The email address | |
| »»»»» phone | string | false | none | The phone number |
| »»»»» vat_number | string | false | none | The VAT number |
| »»»»» eori_number | string | false | none | The EORI number |
| »»»»» comment | string | false | none | Additional information about the address. |
| »»»»» default | boolean | false | none | Whether this is the default shipping address. |
| »» buyer | Public_Entities_OrganizationShort | true | none | none |
| »» incoterm | Public_Entities_Incoterm | false | none | Public_Entities_Incoterm model |
| »»» id | integer(int32) | true | none | The unique Shypple identifier for this incoterm. |
| »»» priority | integer(int32) | false | none | The priority. |
| »»» code | string | true | none | Incoterm code. |
| »»» name | string | true | none | Descriptive incoterm name. |
| »»» role_services | [any] | false | none | Services per shipment role |
| »» loading_port | Public_Entities_Port | false | none | none |
| »» ex_factory_date | string(date-time) | false | none | The ex-factory date |
| »» order_date | string(date-time) | false | none | The order date |
| »» public_po_link | string | false | none | Publik link for particular PO |
| »» cargo_ready_date | string(date-time) | false | none | The cargo ready date |
| »» purchase_order_lines | [Public_Entities_PurchaseOrderLine] | false | none | The purchase order lines |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» url | string | true | none | The url to this purchase order line |
| »»» booking_lines | Public_Entities_BookingLine | false | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» url | string | true | none | The url to this booking line |
| »»»» weight_kg | number(float) | false | none | The weight in kilograms |
| »»»» volume_cbm | number(float) | false | none | The volume in cubic meters |
| »»»» shipment | Public_Entities_ShipmentShort | false | none | none |
| »»»» booking | Public_Entities_BookingShort | false | none | none |
| »»» product_code | string | false | none | The product code |
| »»» product_name | string | false | none | The product name |
| »»» units_ordered | integer(int32) | true | none | The amount of ordered units |
| »»» status | string | false | none | The status of the order line |
| »» total_volume_cbm | number(float) | false | none | The total volume in cubed meters |
| »» total_weight_kg | number(float) | false | none | The total weight in kilograms |
| »» to_plan | boolean | false | none | Is true if at least 1 purchase order line is not associated with a shipment |
| »» original_po_document | Public_Entities_OrganizationDocument | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier of the document. |
| »»» original_filename | string | true | none | The original file name when it was uploaded. |
| »»» download_url | string | false | none | Download URL. Direct link to download document. |
| »»» created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| »» purchase_order_events | [Public_Entities_PurchaseOrderEvent] | false | none | The purchase order events ordered from new to old |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
| »»» user | Public_Entities_User | false | none | none |
| »»» exceptional | boolean | false | none | Is exceptional? |
| »»» template_name | string | false | none | The template name |
| »»» template_variables | object | false | none | All template variables |
| »» exceptional | boolean | false | none | Is exceptional? |
| »» info_requests | [Public_Entities_PurchaseOrderInfoRequest] | false | none | Purchase Order info requests |
| »»» to_email_address | string | false | none | The email address where the information request is sent to. |
| »»» sent_at | string(date-time) | true | none | When the email was sent, in ISO 8601 format |
| »»» additional_message | string | false | none | Extra information from to consignee to the supplier. |
| »»» reminder_sent_at | string(date-time) | false | none | When the reminder email was sent, in ISO 8601 format. |
| »»» response_received_at | string(date-time) | false | none | When the supplier responded to the update request, in ISO 8601 format. |
| »»» marked_no_response_at | string(date-time) | false | none | When the PO was marked with supplier not responding exception, in ISO 8601 format. |
| »»» email_bounced | boolean | false | none | A flag indicating if the email has bounced or not. |
| »» sla_checkpoints | [Public_Entities_SLACheckpoint] | false | none | The SLA checkpoints for this Purchase Order. |
| »» shipments | [Public_Entities_ShipmentShort] | false | none | All shipments linked to this purchase order |
| » booking_index | string | false | none | The booking index name |
| » milestones | Public_Entities_Milestone | false | none | none |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» name | string | true | none | Name of the milestone. |
| »» code | string | true | none | Code of the milestone. |
| »» reached | boolean | false | none | Is milestome reached? |
| »» start_date | string(date) | false | none | Milestone start date |
| »» due_date | string(date) | false | none | Milestone due date |
| »» status | string | false | none | Milestone status |
| »» booking_level | boolean | false | none | Is booking level? |
| »» container_level | boolean | true | none | Is container level? |
| »» tasks | Public_Entities_Task | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» booking | Public_Entities_BookingShort | false | none | none |
| »»» container | Public_Entities_ContainerShort | false | none | none |
| »»» shipment | Public_Entities_ShipmentShort | false | none | none |
| »»» created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| »»» updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| »»» due_date | string(date-time) | false | none | The point in time when this task is due, in ISO 8601 format |
| »»» resolved | string(date-time) | false | none | The resolved datetime, in ISO 8601 format |
| »»» task_type | Public_Entities_TaskType | false | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» name | string | true | none | The name |
| »»»» code | string | true | none | The code |
| »»»» description | string | false | none | The description |
| »»»» column_display_name | string | false | none | Column name |
| »»»» column_display_abbreviation | string | false | none | Column abbreviation |
| »»» task_status | Public_Entities_TaskStatus | false | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» name | string | true | none | The name |
| »»»» order | integer(int32) | false | none | The order of the task status |
| »»»» color | string | false | none | The background color of the task status |
| »»»» icon | string | false | none | The corresponding icon |
| »»»» shortcut | string | false | none | Shortcut of the name(optional) |
| »»»» task_status_type | Public_Entities_TaskStatusType | false | none | none |
| »»»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»»» name | string | true | none | The name |
| »»»»» code | string | true | none | The code |
| »»» possible_task_statuses | [Public_Entities_TaskStatus] | false | none | The task possible statuses |
| »»» milestone | object | false | none | The milestone |
| »»» document_type_code | string | false | none | none |
Download a shipment document
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/shipment_documents/{id} \
-H 'Accept: application/octet-stream' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/shipment_documents/{id} HTTP/1.1
Host: api.shypple.com
Accept: application/octet-stream
const headers = {
'Accept':'application/octet-stream',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipment_documents/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/octet-stream',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/shipment_documents/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/octet-stream',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/shipment_documents/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/octet-stream',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/shipment_documents/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/shipment_documents/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/octet-stream"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/shipment_documents/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/octet-stream',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/shipment_documents/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/shipment_documents/{id}
Redirects to a temporary download url, so make sure to follow redirects.
Returns a 404 error if no document can be found with the provided ID. Returns a 400 error if the provided ID is not an integer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Shipment document id. |
Example responses
200 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download a shipment document | string |
| 400 | Bad Request | Bad request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not found | Public_Entities_Error |
Get a list of contacts by address ID
Code samples
# You can also use wget
curl -X GET https://api.shypple.com/public/v1/addresses/{id}/contacts \
-H 'Accept: application/json' \
-H 'X-Api-Token: API_KEY'
GET https://api.shypple.com/public/v1/addresses/{id}/contacts HTTP/1.1
Host: api.shypple.com
Accept: application/json
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses/{id}/contacts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-Api-Token':'API_KEY'
};
fetch('https://api.shypple.com/public/v1/addresses/{id}/contacts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Api-Token' => 'API_KEY'
}
result = RestClient.get 'https://api.shypple.com/public/v1/addresses/{id}/contacts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Api-Token': 'API_KEY'
}
r = requests.get('https://api.shypple.com/public/v1/addresses/{id}/contacts', headers = headers)
print(r.json())
URL obj = new URL("https://api.shypple.com/public/v1/addresses/{id}/contacts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Api-Token": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.shypple.com/public/v1/addresses/{id}/contacts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
'application/json',
'X-Api-Token' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.shypple.com/public/v1/addresses/{id}/contacts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
GET /v1/addresses/{id}/contacts
Returns a 404 error if no address can be found with the provided ID. Returns a 400 error if the provided ID is not an integer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Address id. |
Example responses
200 Response
[
{
"id": 0,
"name": "string",
"email": "string",
"phone": "string",
"company_address_id": 0,
"company_name": "string",
"company_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"organization_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"comment": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a list of contacts | Inline |
| 400 | Bad Request | Bad Request | Public_Entities_Error |
| 401 | Unauthorized | Unauthorized | Public_Entities_Error |
| 404 | Not Found | Not Found | Public_Entities_Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Public_Entities_Contact] | false | none | [Public_Entities_Contact model] |
| » id | integer(int32) | true | none | The unique Shypple identifier |
| » name | string | true | none | The name |
| string | true | none | The email address | |
| » phone | string | true | none | The phone number |
| » company_address_id | integer(int32) | false | none | The identifier of the company address |
| » company_name | string | false | none | The company name |
| » company_address | Public_Entities_Address | false | none | Public_Entities_Address model |
| »» id | integer(int32) | true | none | The unique Shypple identifier |
| »» url | string | true | none | The url to this address |
| »» name | string | true | none | The address name |
| »» address | string | false | none | Street street name |
| »» postal_code | string | false | none | The postal code |
| »» city | string | false | none | The city |
| »» country | Public_Entities_Country | true | none | Public_Entities_Country model |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | The name of the country |
| »»» title | string | false | none | DEPRECATED - use attribute "name" instead |
| »»» code | string | true | none | The code |
| »»» trade_zone | string | true | none | BENELUX for BE/NL/LU, country code for the others. |
| string | false | none | The email address | |
| »» phone | string | false | none | The phone number |
| »» vat_number | string | false | none | The VAT number |
| »» eori_number | string | false | none | The EORI number |
| »» comment | string | false | none | Additional information about the address. |
| »» default | boolean | false | none | Whether this is the default shipping address. |
| »» connection | Public_Entities_Organization | false | none | none |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | The name |
| »»» prefix | string | true | none | The prefix |
| »»» configured_po_upload | boolean | false | none | Configured Purchase Order tool upload? |
| »»» logo | string | false | none | URL of the organization logo |
| »»» role_code | string | true | none | Code of the organization role |
| »»» default_address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »»» preferred_shipment_role_id | integer(int32) | true | none | ID of the prefered shipment role |
| »»» preferred_forwarder_id | integer(int32) | true | none | ID of preferred freight forwarder connection |
| »»» public_documents | string | false | none | none |
| »» updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| »» ports | [Public_Entities_Port] | false | none | All ports |
| »»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»» name | string | true | none | The name |
| »»» code | string | true | none | The 5-character UN Locode identifier of this port |
| »»» display_name | string | false | none | The display name |
| »»» type | string | false | none | The port type |
| »»» country | Public_Entities_Country | false | none | Public_Entities_Country model |
| »»» time_zone | string | false | none | none |
| »» preferred_modalities | [string] | false | none | All preferred modalities |
| »» sla_checkpoints | [Public_Entities_SLACheckpoint] | false | none | All SLA checkpoints |
| »»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»» name | string | true | none | The name of this SLA checkpoint. |
| »»» dt_days | integer(int32) | true | none | The delta of days (negative is in the past). |
| »»» has_info_requests | boolean | false | none | none |
| »»» owner | Public_Entities_User | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier of the user. |
| »»»» full_name | string | false | none | Full name of the user. |
| string | true | none | Email of the user. | |
| »»»» organization_name | string | false | none | Name of the user organization. |
| »»»» last_active | string(date-time) | true | none | The point in time when this entity was seen last time in ISO 8601 format |
| »»»» out_of_office_till | string(date-time) | false | none | The date the user is out of office until in ISO 8601 format |
| »»»» avatar | string | false | none | URL of user avatar |
| »»» sla_checkpoint_type | Public_Entities_SLACheckpointType | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»»» code | string | true | none | The code of this SLA checkpoint. |
| »»»» name | string | true | none | The name of this SLA checkpoint. |
| »»» sla_checkpoint_value | Public_Entities_SLACheckpointValue | true | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier |
| »»»» date_field | string | true | none | The name of the date field |
| »»»» description | string | true | none | The description of the date field |
| »»» created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| »»» sla_checkpoint_addresses | Public_Entities_SLACheckpointAddress | false | none | none |
| »»»» id | integer(int32) | true | none | The unique Shypple identifier. |
| »»»» automated_alert | boolean | true | none | Indicates if alerts for this address are enabled for the SLA checkpoint. |
| »»»» address | Public_Entities_Address | true | none | Public_Entities_Address model |
| »»» due_date_message_status | Public_Entities_DueDateMessageStatus | false | none | none |
| »»»» due_date | string(date) | false | none | The due date for the SLA checkpoint belonging to the purchase order. |
| »»»» message_status | string | false | none | The message status of the SLA checkpoint belonging to the purchase order. |
| »» full_text | string | false | none | Full text of address |
| » organization_id | integer(int32) | true | none | The identifier of the organization |
| » updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| » comment | string | false | none | Additional information about the contact |
Schemas
postV1Shipments
{
"collaborators": [
{
"organization_id": 0,
"role_codes": [
"third_party_shipment"
]
}
],
"customer_role": "third_party_shipment",
"modality": "sea",
"load_type": "lcl",
"origin_location_type": "address",
"origin_location": "string",
"destination_location_type": "address",
"destination_location": "string",
"estimated_departure_date": "2019-08-24T14:15:22Z",
"allow_create_containers_from_tracking": false,
"dangerous_goods": false,
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"shypple_carrier_id": 0,
"carrier_scac_code": "string",
"services": {
"pickup": true,
"export_customs": true,
"origin_port": true,
"freight": true,
"destination_port": true,
"import_customs": true,
"delivery": true
},
"insurance": true,
"cif_value": 0,
"incoterm": "EXW",
"product_group_code": "string",
"containers": [
{
"container_type_iso": "22G0",
"number": "string",
"seal_number": "string",
"shared_reference": "string"
}
],
"cargo_attributes": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 0,
"goods_description": "string",
"package_type": "BG",
"stackable": true
}
],
"requested_air_tt": [
"fast"
],
"customer_organization_id": 0
}
Create 3PL shipment
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| collaborators | [object] | false | none | Extra collaborators of the shipment |
| » organization_id | integer(int32) | true | none | Internal Shypple Organization(connection) ID. To be retrieved from the API |
| » role_codes | [string] | true | none | Role codes. An array of values of third_party_shipment, notify_party, origin_forwarder, destination_forwarder, shipper, consignee |
| customer_role | string | true | none | Shipment role from the sender of this POST request. Case-sensitive. Accepted values: third_party_shipment, notify_party, origin_forwarder, destination_forwarder, shipper, consignee |
| modality | string | true | none | Modality of a shipment. See enum below |
| load_type | string | true | none | Load type of a shipment. See enum below |
| origin_location_type | string | true | none | address or port_unlocode. |
| origin_location | string | true | none | Either Shypple address_id or port unlocode of origin. |
| destination_location_type | string | true | none | address or port_unlocode. |
| destination_location | string | true | none | Either Shypple address_id or port unlocode of destination. |
| estimated_departure_date | string(date-time) | true | none | Estimated departure datetime or cargo ready datetime. |
| allow_create_containers_from_tracking | boolean | false | none | Allow Track & Trace to create containers for the shipment. |
| dangerous_goods | boolean | false | none | Indication of hazardous goods. |
| reference | string | false | none | Shared reference of your shipment. It'll become visible to all collaborators on the shipment. |
| bl_number | string | false | none | Master bill of lading tracking key. |
| booking_number | string | false | none | Booking number of your shipment. |
| shypple_carrier_id | integer(int32) | false | none | Internal Shypple Carrier ID. To be retrieved from the API |
| carrier_scac_code | string | false | none | SCAC, for more effective T&T activation. If provided, use only one of SCAC/shypple_carrier_id field. |
| services | object | false | none | Your requested services for the shipment. |
| » pickup | boolean | false | none | Transport from pick-up location to port of loading. |
| » export_customs | boolean | false | none | Handling and processing of export customs declarations. |
| » origin_port | boolean | false | none | Terminal handling charges at the origin port. |
| » freight | boolean | false | none | Shipping from port to port. |
| » destination_port | boolean | false | none | Terminal handling charges at the destination port. |
| » import_customs | boolean | false | none | Handling and processing of import customs declarations. |
| » delivery | boolean | false | none | Transport from port of discharge to final destination. |
| insurance | boolean | false | none | Full insurance coverage (calculated according to the goods value). |
| cif_value | number(float) | false | none | Value of the goods (in EUR). |
| incoterm | string | false | none | Incoterm 3 letter code. See enum below |
| product_group_code | string | false | none | Internal Shypple product group code. To be retrieved from the Product Group API endpoint. |
| containers | [object] | true | none | Containers information(for FCL shipments) |
| » container_type_iso | string | true | none | Container type according to ISO standard. See enum below |
| » number | string | false | none | Container number(optional). |
| » seal_number | string | false | none | Seal number(optional). |
| » shared_reference | string | false | none | Shared reference(optional). |
| cargo_attributes | [object] | true | none | Cargo information(for LCL shipments) |
| » height | integer(int32) | true | none | Height of cargo in cm. |
| » width | integer(int32) | true | none | Wight of cargo in cm. |
| » length | integer(int32) | true | none | Length of cargo in cm. |
| » weight | integer(int32) | true | none | Weight of cargo in kg. |
| » quantity | integer(int32) | true | none | Quantity of similar cargos. |
| » goods_description | string | true | none | Text goods description. |
| » package_type | string | true | none | Package Type code. |
| » stackable | boolean | true | none | Indication if the cargo can be stacked. |
| requested_air_tt | [string] | false | none | Requested transit time for AIR shipment. An array of values of fast, courier, regular, cheap |
| customer_organization_id | integer(int32) | false | none | Internal Shypple Customer organization ID. To be retrieved from the API |
Enumerated Values
| Property | Value |
|---|---|
| customer_role | third_party_shipment |
| customer_role | notify_party |
| customer_role | origin_forwarder |
| customer_role | destination_forwarder |
| customer_role | shipper |
| customer_role | consignee |
| modality | sea |
| modality | air |
| modality | rail |
| load_type | lcl |
| load_type | fcl |
| origin_location_type | address |
| origin_location_type | port_unlocode |
| destination_location_type | address |
| destination_location_type | port_unlocode |
| incoterm | EXW |
| incoterm | FCA |
| incoterm | FAS |
| incoterm | FOB |
| incoterm | CFR |
| incoterm | CIF |
| incoterm | CPT |
| incoterm | CIP |
| incoterm | DPU |
| incoterm | DAP |
| incoterm | DDP |
| container_type_iso | 22G0 |
| container_type_iso | 42G0 |
| container_type_iso | 45G0 |
| container_type_iso | L5G1 |
| container_type_iso | 22U1 |
| container_type_iso | 42U1 |
| container_type_iso | 45U1 |
| container_type_iso | 22T0 |
| container_type_iso | 42T0 |
| container_type_iso | 22PC |
| container_type_iso | 42PC |
| container_type_iso | 22GP |
| container_type_iso | 22RE |
| container_type_iso | 22UT |
| container_type_iso | 42GP |
| container_type_iso | 42RE |
| container_type_iso | 42UT |
| container_type_iso | 45RE |
| container_type_iso | L5GP |
| container_type_iso | 20P1 |
| container_type_iso | 20PF |
| container_type_iso | 22P1 |
| container_type_iso | 22P3 |
| container_type_iso | 22P7 |
| container_type_iso | 22P8 |
| container_type_iso | 22P9 |
| container_type_iso | 22PF |
| container_type_iso | 42P1 |
| container_type_iso | 42P3 |
| container_type_iso | 42P6 |
| container_type_iso | 42P8 |
| container_type_iso | 42P9 |
| container_type_iso | 42PF |
| container_type_iso | 42PS |
| container_type_iso | 45P3 |
| container_type_iso | 45P8 |
| container_type_iso | 45PC |
| container_type_iso | 20T0 |
| container_type_iso | 20T1 |
| container_type_iso | 20T2 |
| container_type_iso | 20T3 |
| container_type_iso | 20T4 |
| container_type_iso | 20T5 |
| container_type_iso | 20T6 |
| container_type_iso | 20T7 |
| container_type_iso | 20T8 |
| container_type_iso | 20TD |
| container_type_iso | 20TG |
| container_type_iso | 20TN |
| container_type_iso | 22T1 |
| container_type_iso | 22T2 |
| container_type_iso | 22T3 |
| container_type_iso | 22T4 |
| container_type_iso | 22T5 |
| container_type_iso | 22T6 |
| container_type_iso | 22T7 |
| container_type_iso | 22T8 |
| container_type_iso | 22TD |
| container_type_iso | 22TG |
| container_type_iso | 22TN |
| container_type_iso | 28T8 |
| container_type_iso | 28TG |
| container_type_iso | 42T2 |
| container_type_iso | 42T5 |
| container_type_iso | 42T6 |
| container_type_iso | 42T8 |
| container_type_iso | 42TD |
| container_type_iso | 42TG |
| container_type_iso | 42TN |
| container_type_iso | 48T8 |
| container_type_iso | 48TG |
| container_type_iso | 45G1 |
| container_type_iso | 22G1 |
| container_type_iso | 45GP |
| container_type_iso | 45RT |
| container_type_iso | 22P0 |
| container_type_iso | 42V0 |
| container_type_iso | 45V0 |
| container_type_iso | 22V0 |
| container_type_iso | 42RT |
| container_type_iso | 40RH |
| container_type_iso | 42G1 |
| container_type_iso | 42G2 |
| container_type_iso | 42G3 |
| container_type_iso | 42G4 |
| container_type_iso | 42G5 |
| container_type_iso | 42G6 |
| container_type_iso | 42G7 |
| container_type_iso | 42G8 |
| container_type_iso | 42G9 |
| container_type_iso | 22G2 |
| container_type_iso | 22G3 |
| container_type_iso | 22G4 |
| container_type_iso | 22G5 |
| container_type_iso | 22G6 |
| container_type_iso | 22G7 |
| container_type_iso | 22G8 |
| container_type_iso | 22G9 |
| container_type_iso | 45G2 |
| container_type_iso | 45G3 |
| container_type_iso | 45G4 |
| container_type_iso | 45G5 |
| container_type_iso | 45G6 |
| container_type_iso | 45G7 |
| container_type_iso | 45G8 |
| container_type_iso | 45G9 |
| container_type_iso | L5G0 |
| container_type_iso | L5G2 |
| container_type_iso | L5G3 |
| container_type_iso | L5G4 |
| container_type_iso | L5G5 |
| container_type_iso | L5G6 |
| container_type_iso | L5G7 |
| container_type_iso | L5G8 |
| container_type_iso | L5G9 |
| container_type_iso | 45R1 |
| container_type_iso | 42R0 |
| container_type_iso | 45R0 |
| container_type_iso | 45R2 |
| container_type_iso | 45R3 |
| container_type_iso | 45R4 |
| container_type_iso | 45R5 |
| container_type_iso | 45R6 |
| container_type_iso | 45R7 |
| container_type_iso | 45R8 |
| container_type_iso | 45R9 |
| container_type_iso | 22R0 |
| container_type_iso | 22R1 |
| container_type_iso | 22R2 |
| container_type_iso | 22R3 |
| container_type_iso | 22R4 |
| container_type_iso | 22R5 |
| container_type_iso | 22R6 |
| container_type_iso | 22R7 |
| container_type_iso | 22R8 |
| container_type_iso | 22R9 |
| container_type_iso | 42R1 |
| container_type_iso | 42R2 |
| container_type_iso | 42R3 |
| container_type_iso | 42R4 |
| container_type_iso | 42R5 |
| container_type_iso | 42R6 |
| container_type_iso | 42R7 |
| container_type_iso | 42R8 |
| container_type_iso | 42R9 |
| container_type_iso | unknown |
| package_type | BG |
| package_type | BX |
| package_type | BE |
| package_type | CT |
| package_type | CR |
| package_type | DR |
| package_type | PK |
| package_type | PX |
| package_type | PB |
| package_type | PE |
| package_type | RO |
| package_type | TU |
Public_Entities_Shipment
{
"id": 0,
"url": "string",
"public_url": "string",
"type": "string",
"load_type": "string",
"title": "string",
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"status_text": "string",
"status_code": "string",
"customs_documentation_complete": {},
"estimated_departure_date": "2019-08-24",
"actual_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"actual_arrival_date": "2019-08-24",
"voyage_no": "string",
"pickup_time_from": "2019-08-24T14:15:22Z",
"pickup_time_until": "2019-08-24T14:15:22Z",
"pickup_address_text": "string",
"delivery_time_from": "2019-08-24T14:15:22Z",
"delivery_time_until": "2019-08-24T14:15:22Z",
"delivery_address_text": "string",
"transportation_costs": "string",
"duty_tax_costs": "string",
"costs_currency": {},
"total_cargo_chargeable_weight_kg": 0,
"carrier": {
"id": 0,
"name": "string",
"scac": "string",
"carrier_alliance_name": "string",
"carrier_alliance_code": "string",
"preferred_tracking_key": "string",
"ocean_insights_coverage": "string",
"carrier_type": "string"
},
"product_group": {
"id": 0,
"name": "string",
"code": "string"
},
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"containers": {
"id": 0,
"type": "string",
"number": "string",
"seal_number": "string",
"shared_reference": "string",
"total_cargo_weight_kg": 0,
"cargo": {
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
},
"documents": {
"id": 0,
"type": "string",
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"document_manageable": true,
"viewable_by": [
{
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
]
},
"bookings": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"changed_since": "2019-08-24T14:15:22Z"
}
Public_Entities_Shipment model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier of this shipment |
| url | string | true | none | The url to this shipment |
| public_url | string | false | none | The public url to this shipment |
| type | string | true | none | The modality of the shipment e.g. sea or air |
| load_type | string | true | none | The load type of the shipment: FCL or LCL |
| title | string | false | none | The title of the Shipment as shown in the web application |
| reference | string | false | none | Your reference for this shipment |
| bl_number | string | false | none | The Bill of Lading (BL) number for this shipment |
| booking_number | string | false | none | The booking number for this shipment |
| status_text | string | false | none | The current status name of this shipment |
| status_code | string | false | none | The current status code of this shipment |
| customs_documentation_complete | object | false | none | DEPRECATED: do not use |
| estimated_departure_date | string(date) | true | none | Estimated Departure Date |
| actual_departure_date | string(date) | true | none | Actual Departure Date |
| estimated_arrival_date | string(date) | true | none | Estimated Arrival Date |
| actual_arrival_date | string(date) | true | none | Actual Arrival Date |
| voyage_no | string | false | none | Current leg's voyage number |
| pickup_time_from | string(date-time) | false | none | Earliest pickup time, in the local time of the pickup location. |
| pickup_time_until | string(date-time) | false | none | Latest pickup time, in the local time of the pickup location. |
| pickup_address_text | string | false | none | The address where the shipment is to be picked up |
| delivery_time_from | string(date-time) | false | none | Earliest delivery time, in the local time of the delivery location. |
| delivery_time_until | string(date-time) | false | none | Latest delivery time, in the local time of the delivery location. |
| delivery_address_text | string | false | none | The address where the shipment is to be delivered |
| transportation_costs | string | false | none | Total transportation costs. |
| duty_tax_costs | string | false | none | Total duties and/or tax costs paid at customs. |
| costs_currency | object | false | none | The currency for transportation_costs and duty_tax_costs, in 3-letter ISO code, e.g. EUR or USD |
| total_cargo_chargeable_weight_kg | integer(int32) | false | none | Total cargo chargeable weight in kg |
| carrier | Public_Entities_Carrier | false | none | Public_Entities_Carrier model |
| product_group | Public_Entities_ProductGroup | false | none | Public_Entities_ProductGroup model |
| port_pair | Public_Entities_PortPair | false | none | none |
| containers | Public_Entities_Container | false | none | none |
| documents | Public_Entities_ShipmentDocument | false | none | none |
| bookings | Public_Entities_BookingShort | false | none | none |
| created_at | string(date-time) | true | none | The point in time when this shipment was created. ISO 8601 format. |
| updated_at | string(date-time) | true | none | The point in time when this shipment was last updated. ISO 8601 format. |
| changed_since | string(date-time) | true | none | The point in time when this shipment was last updated. ISO 8601 format. |
Public_Entities_Carrier
{
"id": 0,
"name": "string",
"scac": "string",
"carrier_alliance_name": "string",
"carrier_alliance_code": "string",
"preferred_tracking_key": "string",
"ocean_insights_coverage": "string",
"carrier_type": "string"
}
Public_Entities_Carrier model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | The name |
| scac | string | true | none | Standard Carrier Alpha Code (SCAC) |
| carrier_alliance_name | string | false | none | none |
| carrier_alliance_code | string | false | none | none |
| preferred_tracking_key | string | false | none | none |
| ocean_insights_coverage | string | false | none | none |
| carrier_type | string | false | none | none |
Public_Entities_ProductGroup
{
"id": 0,
"name": "string",
"code": "string"
}
Public_Entities_ProductGroup model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier for this product group. |
| name | string | true | none | Name of the product group. |
| code | string | true | none | Unique code of the product group. |
Public_Entities_PortPair
{
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| loading_port | Public_Entities_Port | true | none | none |
| discharge_port | Public_Entities_Port | true | none | none |
| tradelane | string | false | none | none |
Public_Entities_Port
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | The name |
| code | string | true | none | The 5-character UN Locode identifier of this port |
| display_name | string | false | none | The display name |
| type | string | false | none | The port type |
| country | Public_Entities_Country | false | none | Public_Entities_Country model |
| time_zone | string | false | none | none |
Public_Entities_Country
{
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
}
Public_Entities_Country model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | The name of the country |
| title | string | false | none | DEPRECATED - use attribute "name" instead |
| code | string | true | none | The code |
| trade_zone | string | true | none | BENELUX for BE/NL/LU, country code for the others. |
Public_Entities_Container
{
"id": 0,
"type": "string",
"number": "string",
"seal_number": "string",
"shared_reference": "string",
"total_cargo_weight_kg": 0,
"cargo": {
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| type | string | true | none | The type of this container |
| number | string | false | none | The container number |
| seal_number | string | false | none | The container's seal number |
| shared_reference | string | false | none | The container's shared reference |
| total_cargo_weight_kg | number(float) | false | none | The total cargo weight in kilograms |
| cargo | Public_Entities_Cargo | false | none | none |
Public_Entities_Cargo
{
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| url | string | true | none | The url to this cargo. |
| container | Public_Entities_ContainerShort | true | none | none |
| goods_description | string | false | none | The goods description |
| stackable | boolean | true | none | Is the cargo stackable? |
| quantity | integer(int32) | true | none | The quantity |
| total_weight_kg | number(float) | true | none | The total weight in kilograms |
| length_mm | integer(int32) | false | none | The length in millimeters |
| width_mm | integer(int32) | false | none | The width in millimeters |
| height_mm | integer(int32) | false | none | The height in millimeters |
| volume_cbm | number(float) | true | none | Volume of the cargo in cubic meters |
| marks_and_numbers | string | false | none | The marks and numbers |
| package_type | Public_Entities_PackageTypeShort | true | none | none |
| package_type_name | string | false | none | The package type name |
| package_type_code | string | false | none | The package type code |
| created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
| booking_id | integer(int32) | false | none | The booking identifier |
| slac | integer(int32) | false | none | The SLAC |
Public_Entities_ContainerShort
{
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier for this container. |
| status | string | false | none | Container status if being tracked by portbase |
| number | string | false | none | The container number |
| url | string | true | none | The url to this container. |
| type | string | true | none | The type of container: 20_ft, 40_ft, 40_ft_hc, 45_ft or unknown |
| type_name | string | false | none | The type of container: 20 FT, 40 FY, 40 FT HC, 45 FT or Unknown |
| container_index | string | true | none | The container index name |
| container_event_exceptions | [string] | false | none | Exception event types |
| pod_customs_documents_present | boolean | false | none | True if documents are present at discharge port |
| pod_customs_inspection_status | string | false | none | Customs inspection status if container is notified or released from customs checks |
| pod_customs_inspection_type | string | false | none | The type of customs check that can be expected |
| discharged_at | string(date-time) | false | none | Container discharge time |
| shared_reference | string | false | none | Container shared reference |
Public_Entities_PackageTypeShort
{
"id": 0,
"code": "string",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier for this package type. |
| code | string | true | none | The code |
| name | string | true | none | The name |
Public_Entities_ShipmentDocument
{
"id": 0,
"type": "string",
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"document_manageable": true,
"viewable_by": [
{
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier of the document. |
| type | string | false | none | The standardized type of the document. |
| original_filename | string | true | none | The original file name when it was uploaded. |
| description | string | false | none | Optional extra description about the contents of the file. |
| url | string | true | none | Download URL. Make sure you follow redirects. |
| download_url | string | false | none | Download URL. Direct link to downlod document. |
| created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| containers | Public_Entities_ContainerShort | false | none | none |
| uploaded_by | Public_Entities_User | false | none | none |
| booking | Public_Entities_BookingShort | false | none | none |
| document_manageable | boolean | false | none | Document manageable by user role. |
| viewable_by | [Public_Entities_Organization] | false | none | All organizations |
Public_Entities_User
{
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier of the user. |
| full_name | string | false | none | Full name of the user. |
| string | true | none | Email of the user. | |
| organization_name | string | false | none | Name of the user organization. |
| last_active | string(date-time) | true | none | The point in time when this entity was seen last time in ISO 8601 format |
| out_of_office_till | string(date-time) | false | none | The date the user is out of office until in ISO 8601 format |
| avatar | string | false | none | URL of user avatar |
Public_Entities_BookingShort
{
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique identifier of the booking. |
| url | string | true | none | The url to this booking. |
| booking_reference | string | false | none | Booking reference` for the booking. |
| booking_index | string | false | none | Booking index in shipment. |
| shipper_name | string | false | none | Name of the shipper organization. |
| consignee_name | string | false | none | Name of the consignee organization. |
Public_Entities_Organization
{
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | The name |
| prefix | string | true | none | The prefix |
| configured_po_upload | boolean | false | none | Configured Purchase Order tool upload? |
| logo | string | false | none | URL of the organization logo |
| role_code | string | true | none | Code of the organization role |
| default_address | Public_Entities_Address | true | none | Public_Entities_Address model |
| preferred_shipment_role_id | integer(int32) | true | none | ID of the prefered shipment role |
| preferred_forwarder_id | integer(int32) | true | none | ID of preferred freight forwarder connection |
| public_documents | string | false | none | none |
Public_Entities_Address
{
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
}
Public_Entities_Address model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| url | string | true | none | The url to this address |
| name | string | true | none | The address name |
| address | string | false | none | Street street name |
| postal_code | string | false | none | The postal code |
| city | string | false | none | The city |
| country | Public_Entities_Country | true | none | Public_Entities_Country model |
| string | false | none | The email address | |
| phone | string | false | none | The phone number |
| vat_number | string | false | none | The VAT number |
| eori_number | string | false | none | The EORI number |
| comment | string | false | none | Additional information about the address. |
| default | boolean | false | none | Whether this is the default shipping address. |
| connection | Public_Entities_Organization | false | none | none |
| updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| ports | [Public_Entities_Port] | false | none | All ports |
| preferred_modalities | [string] | false | none | All preferred modalities |
| sla_checkpoints | [Public_Entities_SLACheckpoint] | false | none | All SLA checkpoints |
| full_text | string | false | none | Full text of address |
Public_Entities_SLACheckpoint
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier. |
| name | string | true | none | The name of this SLA checkpoint. |
| dt_days | integer(int32) | true | none | The delta of days (negative is in the past). |
| has_info_requests | boolean | false | none | none |
| owner | Public_Entities_User | true | none | none |
| sla_checkpoint_type | Public_Entities_SLACheckpointType | true | none | none |
| sla_checkpoint_value | Public_Entities_SLACheckpointValue | true | none | none |
| created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| sla_checkpoint_addresses | Public_Entities_SLACheckpointAddress | false | none | none |
| due_date_message_status | Public_Entities_DueDateMessageStatus | false | none | none |
Public_Entities_SLACheckpointType
{
"id": 0,
"code": "string",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier. |
| code | string | true | none | The code of this SLA checkpoint. |
| name | string | true | none | The name of this SLA checkpoint. |
Public_Entities_SLACheckpointValue
{
"id": 0,
"date_field": "string",
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| date_field | string | true | none | The name of the date field |
| description | string | true | none | The description of the date field |
Public_Entities_SLACheckpointAddress
{
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier. |
| automated_alert | boolean | true | none | Indicates if alerts for this address are enabled for the SLA checkpoint. |
| address | Public_Entities_Address | true | none | Public_Entities_Address model |
Public_Entities_DueDateMessageStatus
{
"due_date": "2019-08-24",
"message_status": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| due_date | string(date) | false | none | The due date for the SLA checkpoint belonging to the purchase order. |
| message_status | string | false | none | The message status of the SLA checkpoint belonging to the purchase order. |
Public_Entities_Error
{
"error": "string"
}
Public_Entities_Error model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| error | string | false | none | Error description. |
postV1ShipmentsOneview
{
"collaborators": [
{
"organization_id": 0,
"role_codes": [
"third_party_shipment"
]
}
],
"customer_role": "third_party_shipment",
"bl_number": "string",
"booking_number": "string",
"container_number": "string",
"reference": "string",
"shypple_carrier_id": 0,
"carrier_scac_code": "string",
"product_group_code": "string",
"customer_organization_id": 0
}
Create OneView shipment
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| collaborators | [object] | false | none | Extra collaborators of the shipment |
| » organization_id | integer(int32) | true | none | Internal Shypple Organization(connection) ID. To be retrieved from the API |
| » role_codes | [string] | true | none | Role codes. An array of values of third_party_shipment, notify_party, origin_forwarder, destination_forwarder, shipper, consignee |
| customer_role | string | true | none | Shipment role from the sender of this POST request. Case-sensitive. Accepted values: third_party_shipment, notify_party, origin_forwarder, destination_forwarder, shipper, consignee |
| bl_number | string | false | none | BL(MBL) number. |
| booking_number | string | false | none | Booking number. |
| container_number | string | false | none | One of the containers' number |
| reference | string | false | none | Shared reference of your shipment. It'll become visible to all collaborators on the shipment. |
| shypple_carrier_id | integer(int32) | false | none | Internal Shypple Carrier ID. To be retrieved from the API |
| carrier_scac_code | string | false | none | SCAC. Request requires presence of either SCAC or carrier_id |
| product_group_code | string | false | none | Internal Shypple code group ID. To be retrieved from the Product Group API endpoint. |
| customer_organization_id | integer(int32) | false | none | Internal Shypple Customer organization ID. To be retrieved from the API |
Enumerated Values
| Property | Value |
|---|---|
| customer_role | third_party_shipment |
| customer_role | notify_party |
| customer_role | origin_forwarder |
| customer_role | destination_forwarder |
| customer_role | shipper |
| customer_role | consignee |
Public_Entities_ShipmentList
{
"url": "string",
"next": "string",
"first": "string",
"last": "string",
"shipments": [
{
"id": 0,
"url": "string",
"public_url": "string",
"load_type": "string",
"type": "string",
"shipment_type": "string",
"title": "string",
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"closing_datetime": "2019-08-24T14:15:22Z",
"closing_datetime_status": "string",
"pickup_available_from": "2019-08-24T14:15:22Z",
"pickup_available_to": "2019-08-24T14:15:22Z",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z",
"delivery_available_from": "2019-08-24T14:15:22Z",
"shipment_phase": "string",
"status": "string",
"status_text": "string",
"customs_documentation_complete": {},
"estimated_departure_date": "2019-08-24",
"actual_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"actual_arrival_date": "2019-08-24",
"transportation_costs": "string",
"duty_tax_costs": "string",
"costs_currency": {},
"total_costs_per_cbm": "string",
"total_costs_per_teu": "string",
"total_cargo_chargeable_weight_kg": 0,
"carrier": {
"id": 0,
"name": "string",
"scac": "string",
"carrier_alliance_name": "string",
"carrier_alliance_code": "string",
"preferred_tracking_key": "string",
"ocean_insights_coverage": "string",
"carrier_type": "string"
},
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"latitude": "string",
"longitude": "string",
"vessel": {
"id": 0,
"name": "string",
"imo": 0
},
"voyage_no": "string",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"bookings": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"incoterm": "string",
"product_group": {
"id": 0,
"name": "string",
"code": "string"
},
"has_reefer_containers": "string",
"total_emission_gram": 0,
"total_ttw_emission_gram": 0,
"total_wtt_emission_gram": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"changed_since": "2019-08-24T14:15:22Z",
"temperature_setting": "string"
}
]
}
Public_Entities_ShipmentList model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| url | string | false | none | Current page url |
| next | string | false | none | URL to the next page, null if not available |
| first | string | false | none | URL to the first page |
| last | string | false | none | URL to the last page |
| shipments | [Public_Entities_ShipmentV2] | false | none | Shipments |
Public_Entities_ShipmentV2
{
"id": 0,
"url": "string",
"public_url": "string",
"load_type": "string",
"type": "string",
"shipment_type": "string",
"title": "string",
"reference": "string",
"bl_number": "string",
"booking_number": "string",
"closing_datetime": "2019-08-24T14:15:22Z",
"closing_datetime_status": "string",
"pickup_available_from": "2019-08-24T14:15:22Z",
"pickup_available_to": "2019-08-24T14:15:22Z",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z",
"delivery_available_from": "2019-08-24T14:15:22Z",
"shipment_phase": "string",
"status": "string",
"status_text": "string",
"customs_documentation_complete": {},
"estimated_departure_date": "2019-08-24",
"actual_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"actual_arrival_date": "2019-08-24",
"transportation_costs": "string",
"duty_tax_costs": "string",
"costs_currency": {},
"total_costs_per_cbm": "string",
"total_costs_per_teu": "string",
"total_cargo_chargeable_weight_kg": 0,
"carrier": {
"id": 0,
"name": "string",
"scac": "string",
"carrier_alliance_name": "string",
"carrier_alliance_code": "string",
"preferred_tracking_key": "string",
"ocean_insights_coverage": "string",
"carrier_type": "string"
},
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"latitude": "string",
"longitude": "string",
"vessel": {
"id": 0,
"name": "string",
"imo": 0
},
"voyage_no": "string",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"bookings": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"incoterm": "string",
"product_group": {
"id": 0,
"name": "string",
"code": "string"
},
"has_reefer_containers": "string",
"total_emission_gram": 0,
"total_ttw_emission_gram": 0,
"total_wtt_emission_gram": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"changed_since": "2019-08-24T14:15:22Z",
"temperature_setting": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| url | string | true | none | The url to this shipment |
| public_url | string | false | none | The public url to this shipment |
| load_type | string | false | none | The load type of the shipment: FCL or LCL |
| type | string | false | none | The modality of the shipment e.g. sea or air |
| shipment_type | string | false | none | The type of shipment: FCL, LCL, AIR, ROAD, or RAIL |
| title | string | false | none | The title of the Shipment as shown in the web application |
| reference | string | false | none | Your reference for this shipment |
| bl_number | string | false | none | The Bill of Lading (BL) number for this shipment |
| booking_number | string | false | none | The booking number for this shipment |
| closing_datetime | string(date-time) | true | none | Closing datetime, in ISO 8601 format |
| closing_datetime_status | string | false | none | Closing datetime status |
| pickup_available_from | string(date-time) | false | none | Pickup available datetime, in ISO 8601 format |
| pickup_available_to | string(date-time) | false | none | Pickup available to, in ISO 8601 format |
| destination_demurrage_starting_from | string(date-time) | false | none | Destination demurrage starting from datetime, in ISO 8601 format |
| delivery_available_from | string(date-time) | false | none | Delivery available from datetime, in ISO 8601 format |
| shipment_phase | string | false | none | The shipment phase |
| status | string | false | none | Updated status representation |
| status_text | string | false | none | The current status of this shipment. Legacy, to continue support public API implementation |
| customs_documentation_complete | object | false | none | DEPRECATED: do not use |
| estimated_departure_date | string(date) | true | none | Estimated Departure Date |
| actual_departure_date | string(date) | true | none | Actual Departure Date |
| estimated_arrival_date | string(date) | true | none | Estimated Arrival Date |
| actual_arrival_date | string(date) | true | none | Actual Arrival Date |
| transportation_costs | string | false | none | Total transportation costs. |
| duty_tax_costs | string | false | none | Total duties and/or tax costs paid at customs. |
| costs_currency | object | false | none | The currency for transportation_costs and duty_tax_costs, in 3-letter ISO code, e.g. EUR or USD |
| total_costs_per_cbm | string | false | none | Total costs paid per cbm |
| total_costs_per_teu | string | false | none | Total costs paid per teu |
| total_cargo_chargeable_weight_kg | integer(int32) | false | none | Total cargo chargeable weight in kg |
| carrier | Public_Entities_Carrier | false | none | Public_Entities_Carrier model |
| port_pair | Public_Entities_PortPair | false | none | none |
| latitude | string | false | none | The shipment latitude |
| longitude | string | false | none | The shipment longitude |
| vessel | Public_Entities_Vessel | false | none | none |
| voyage_no | string | false | none | Current leg's voyage number |
| containers | Public_Entities_ContainerShort | false | none | none |
| documents | Public_Entities_ShipmentDocumentV2 | false | none | none |
| bookings | Public_Entities_BookingShort | false | none | none |
| incoterm | string | false | none | Incoterm |
| product_group | Public_Entities_ProductGroup | false | none | Public_Entities_ProductGroup model |
| has_reefer_containers | string | false | none | none |
| total_emission_gram | integer(int32) | false | none | Total CO2 emissions for this shipment |
| total_ttw_emission_gram | integer(int32) | false | none | Total direct/tank-to-wheel emissions |
| total_wtt_emission_gram | integer(int32) | false | none | Total indirect/well-to-tank emissions |
| created_at | string(date-time) | true | none | The point in time when this shipment was created. ISO 8601 format. |
| updated_at | string(date-time) | true | none | The point in time when this shipment was last updated. ISO 8601 format. |
| changed_since | string(date-time) | true | none | The point in time when this shipment was last updated. ISO 8601 format. |
| temperature_setting | string | true | none | Temperature setting of the shipments. One of these values(dry, hot, cold) |
Public_Entities_Vessel
{
"id": 0,
"name": "string",
"imo": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | A vessel name |
| imo | integer(int32) | true | none | IMO (International Maritime Organization) number of a vessel |
Public_Entities_ShipmentDocumentV2
{
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier of the document. |
| types | [Public_Entities_DocumentType] | false | none | All document_types |
| original_filename | string | true | none | The original file name when it was uploaded. |
| description | string | false | none | Optional extra description about the contents of the file. |
| url | string | true | none | Download URL. Make sure you follow redirects. |
| download_url | string | false | none | Download URL. Direct link to download document. |
| created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| containers | Public_Entities_ContainerShort | false | none | none |
| uploaded_by | Public_Entities_User | false | none | none |
| booking | Public_Entities_BookingShort | false | none | none |
| shipment | Public_Entities_ShipmentShort | false | none | none |
| document_manageable | boolean | false | none | Document manageable by user role. |
| viewable_by | Public_Entities_Organization | false | none | none |
Public_Entities_DocumentType
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | Name of document type. |
| code | string | true | none | Code of document type. |
| shipment_level | boolean | true | none | Can be assigned to shipment. |
| container_level | boolean | true | none | Can be assigned to container. |
| booking_level | boolean | true | none | Can be assigned to booking. |
| organization_level | boolean | true | none | Can be assigned to organization. |
| created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
Public_Entities_ShipmentShort
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier for this shipment. |
| reference | string | false | none | Your reference for this shipment |
| our_reference | string | false | none | Shypple's reference for this shipment |
| internal_reference | string | false | none | Shypple's reference for current organization |
| url | string | true | none | The url to this shipment. |
| public_shipment_link | string | false | none | The url to this shipment. |
| port_pair | Public_Entities_PortPair | false | none | none |
| estimated_departure_date | string(date) | true | none | Estimated Departure Date |
| estimated_arrival_date | string(date) | true | none | Estimated Arrival Date |
| destination_demurrage_starting_from | string(date-time) | false | none | none |
Public_Entities_ContainerV2
{
"id": 0,
"status": "string",
"container_event_exceptions": [
"string"
],
"shared_reference": "string",
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"number": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"seal_number": "string",
"type": "string",
"devanning_date": "2019-08-24",
"discharged_at": "2019-08-24T14:15:22Z",
"total_cargo_weight_kg": 0,
"total_volume_cbm": 0,
"packages": 0,
"hs_codes": [
{
"id": 0,
"goods_code": "string",
"description": "string",
"notes": "string"
}
],
"cargo": [
{
"id": 0,
"url": "string",
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"goods_description": "string",
"stackable": true,
"quantity": 0,
"total_weight_kg": 0,
"length_mm": 0,
"width_mm": 0,
"height_mm": 0,
"volume_cbm": 0,
"marks_and_numbers": "string",
"package_type": {
"id": 0,
"code": "string",
"name": "string"
},
"package_type_name": "string",
"package_type_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"booking_id": 0,
"slac": 0
}
],
"inland_transports": [
{
"id": 0,
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"shipment_details": "string",
"modality": "string",
"carrier": "string",
"cargo_weight_kg": "string",
"service": "string",
"status": "string",
"transporter_status": "string",
"pickup_delivery_time": "2019-08-24T14:15:22Z",
"closing_time": "2019-08-24T14:15:22Z",
"pickup_delivery_time_editable": true,
"inland_transport_addresses": [
{
"id": 0,
"inland_transport": {
"id": 0,
"service": "string",
"url": "string"
},
"pickup_delivery": true,
"reference": "string",
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"datetime_status": "string",
"datetime_manageable?": {},
"url": "string",
"name": "string",
"address_id": 0,
"address_type": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"comment": "string",
"vat_number": "string",
"eori_number": "string",
"latitude": 0,
"longitude": 0
}
],
"url": "string"
}
],
"url": "string",
"container_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"event_type_description": "string",
"template_variables": {},
"exception": "string"
}
],
"milestones": "string",
"temperature": "string",
"humidity": "string",
"vents_open": true,
"drains_open": true,
"co2_regulation": "string",
"ventilation": "string",
"comments": "string",
"equipment_controlled_atmosphere": true,
"tare_weight_kg": 0
}
Public_Entities_ContainerV2 model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique identifier of the container |
| status | string | false | none | Container status if being tracked by portbase |
| container_event_exceptions | [string] | false | none | Exception event types |
| shared_reference | string | false | none | The container's shared reference |
| pod_customs_documents_present | boolean | false | none | True if documents are present at discharge port |
| pod_customs_inspection_status | string | false | none | Customs inspection status if container is notified or released from customs checks |
| pod_customs_inspection_type | string | false | none | The type of customs check that can be expected |
| number | string | false | none | Container number |
| shipment | Public_Entities_ShipmentShort | true | none | none |
| seal_number | string | false | none | The seal_number for the container |
| type | string | true | none | The type code of container: 20_ft, 40_ft, 40_ft_hc, 45_ft or unknown |
| devanning_date | string(date) | false | none | Date on which shipment will be devanned or (deconsolidated) at the Container Freight Station. Only applicable for shipments with type = LCL |
| discharged_at | string(date-time) | false | none | Container discharge time |
| total_cargo_weight_kg | integer(int32) | false | none | Total weight of the cargo in this container in kilograms |
| total_volume_cbm | integer(int32) | false | none | Total volume of the cargo in this container in cbm |
| packages | integer(int32) | false | none | The total number of packages in this container |
| hs_codes | [Public_Entities_ContainerHSCode] | false | none | All container HS codes |
| cargo | [Public_Entities_Cargo] | false | none | All cargos |
| inland_transports | [Public_Entities_InlandTransport] | false | none | All inland transports |
| url | string | true | none | The url to this container |
| container_events | [Public_Entities_ContainerEvent] | false | none | The container event ordered from new to old |
| milestones | string | false | none | Public::Entities::Milestone |
| temperature | string | false | none | Temperature value / range. |
| humidity | string | false | none | Humidity of the container. |
| vents_open | boolean | false | none | none |
| drains_open | boolean | false | none | none |
| co2_regulation | string | false | none | none |
| ventilation | string | false | none | none |
| comments | string | false | none | none |
| equipment_controlled_atmosphere | boolean | false | none | Whether it is controlled atmophere or not. |
| tare_weight_kg | integer(int32) | false | none | The tare weight of the container in kilograms |
Public_Entities_ContainerHSCode
{
"id": 0,
"goods_code": "string",
"description": "string",
"notes": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| goods_code | string | false | none | The goods code |
| description | string | false | none | The description |
| notes | string | false | none | BENELUX for BE/NL/LU, country code for the others. |
Public_Entities_InlandTransport
{
"id": 0,
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"shipment_details": "string",
"modality": "string",
"carrier": "string",
"cargo_weight_kg": "string",
"service": "string",
"status": "string",
"transporter_status": "string",
"pickup_delivery_time": "2019-08-24T14:15:22Z",
"closing_time": "2019-08-24T14:15:22Z",
"pickup_delivery_time_editable": true,
"inland_transport_addresses": [
{
"id": 0,
"inland_transport": {
"id": 0,
"service": "string",
"url": "string"
},
"pickup_delivery": true,
"reference": "string",
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"datetime_status": "string",
"datetime_manageable?": {},
"url": "string",
"name": "string",
"address_id": 0,
"address_type": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"comment": "string",
"vat_number": "string",
"eori_number": "string",
"latitude": 0,
"longitude": 0
}
],
"url": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier for the inland transport |
| container | Public_Entities_ContainerShort | true | none | none |
| shipment | Public_Entities_ShipmentShort | true | none | none |
| shipment_details | string | true | none | Details about the shipment |
| modality | string | true | none | The modality of this Inland Transport: road, barge or rail |
| carrier | string | false | none | The name of the carrier for the shipment |
| cargo_weight_kg | string | false | none | The total weight of the cargo in kg |
| service | string | true | none | The service of this Inland Transport: pickup or delivery |
| status | string | true | none | The status of this Inland Transport: estimated, proposed, requested or confirmed |
| transporter_status | string | true | none | The transporter status of this Inland Transport: open, accepted or completed |
| pickup_delivery_time | string(date-time) | false | none | The time of pickup or delivery, in ISO 8601 format |
| closing_time | string(date-time) | false | none | The closing time of pickup or delivery, in ISO 8601 format |
| pickup_delivery_time_editable | boolean | true | none | Whether the pickup_delivery_time attribute is editable |
| inland_transport_addresses | [Public_Entities_InlandTransportAddress] | false | none | All inland transport addresses |
| url | string | true | none | The url to this inland transport |
Public_Entities_InlandTransportAddress
{
"id": 0,
"inland_transport": {
"id": 0,
"service": "string",
"url": "string"
},
"pickup_delivery": true,
"reference": "string",
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"datetime_status": "string",
"datetime_manageable?": {},
"url": "string",
"name": "string",
"address_id": 0,
"address_type": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"comment": "string",
"vat_number": "string",
"eori_number": "string",
"latitude": 0,
"longitude": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier for this inland transport address |
| inland_transport | Public_Entities_InlandTransportShort | true | none | none |
| pickup_delivery | boolean | true | none | Is pickup delivery address? |
| reference | string | false | none | The reference |
| datetime_from | string(date-time) | false | none | The formatted from-datetime |
| datetime_to | string(date-time) | false | none | The formatted to-datetime |
| datetime_status | string | true | none | The status of the date time above: estimated, requested, proposed, confirmed |
| datetime_manageable? | object | false | none | Is datetime manageable? |
| url | string | true | none | The url to this inland transport address |
| name | string | false | none | The name |
| address_id | integer(int32) | false | none | The identifier of the address |
| address_type | string | false | none | One of the address types. |
| address | string | false | none | Street address. |
| postal_code | string | false | none | The postal code |
| city | string | false | none | The city name |
| country | Public_Entities_Country | false | none | Public_Entities_Country model |
| comment | string | false | none | The comment |
| vat_number | string | false | none | The VAT number |
| eori_number | string | false | none | The EORI number |
| latitude | number(float) | false | none | The GPS latitude coordinate |
| longitude | number(float) | false | none | The GPS longitude coordinate |
Public_Entities_InlandTransportShort
{
"id": 0,
"service": "string",
"url": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier for this inland transport. |
| service | string | true | none | The service name |
| url | string | true | none | The url to this inland transport. |
Public_Entities_ContainerEvent
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"event_type_description": "string",
"template_variables": {},
"exception": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
| user | Public_Entities_User | false | none | none |
| template_name | string | false | none | The template name |
| event_type_description | string | false | none | Human description of event |
| template_variables | object | false | none | All template variables |
| exception | string | false | none | Is true when container event is an exception |
Public_Entities_ShipmentOrganization
{
"id": 0,
"organization_id": 0,
"flagged_at": "2019-08-24T14:15:22Z",
"name": "string",
"logo": "string",
"organization_role_code": "string",
"organization_role_name": "string",
"manageable": true,
"roles": [
null
]
}
Public_Entities_ShipmentOrganization model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| organization_id | integer(int32) | true | none | The unique Shypple identifier |
| flagged_at | string(date-time) | true | none | Datetime when shipment was flagged for organization |
| name | string | true | none | Name of organization |
| logo | string | true | none | URL of the organization logo |
| organization_role_code | string | true | none | Code of the organziation role |
| organization_role_name | string | true | none | Name of the organziation role |
| manageable | boolean | true | none | Is manageable by current user orgnaization |
| roles | [any] | true | none | Array of shipment organization shipment roles |
Public_Entities_Booking
{
"id": 0,
"url": "string",
"booking_reference": "string",
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"cargo_ready_date": "2019-08-24",
"house_bl": "string",
"incoterm": "string",
"commercial_invoice_and_packing_list_uploaded": true,
"booking_parties_information_complete": true,
"consignee_as_notify_party": true,
"shipment_documents": {
"id": 0,
"types": [
{
"id": 0,
"name": "string",
"code": "string",
"shipment_level": true,
"container_level": true,
"booking_level": true,
"organization_level": true,
"created_at": "2019-08-24T14:15:22Z"
}
],
"original_filename": "string",
"description": "string",
"url": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"containers": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"uploaded_by": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"document_manageable": true,
"viewable_by": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
}
},
"shipper": {},
"consignee": {},
"notify_party": {},
"booking_events": {
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"template_variables": {}
},
"purchase_orders": {
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
},
"booking_index": "string",
"milestones": {
"id": 0,
"name": "string",
"code": "string",
"reached": true,
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"status": "string",
"booking_level": true,
"container_level": true,
"tasks": {
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
}
}
Public_Entities_Booking model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique identifier of the booking |
| url | string | true | none | The url to this booking |
| booking_reference | string | false | none | The booking reference for the booking |
| shipment | Public_Entities_ShipmentShort | false | none | none |
| cargo_ready_date | string(date) | false | none | Cargo ready date |
| house_bl | string | false | none | House BL |
| incoterm | string | false | none | Incoterm |
| commercial_invoice_and_packing_list_uploaded | boolean | true | none | customs_documentation_complete |
| booking_parties_information_complete | boolean | true | none | booking_parties_information_complete |
| consignee_as_notify_party | boolean | true | none | consignee_as_notify_party |
| shipment_documents | Public_Entities_ShipmentDocumentV2 | false | none | none |
| shipper | object | false | none | The shipper |
| consignee | object | false | none | The consignee |
| notify_party | object | false | none | The notify party |
| booking_events | Public_Entities_BookingEvent | false | none | none |
| purchase_orders | Public_Entities_PurchaseOrder | false | none | Public_Entities_PurchaseOrder model |
| booking_index | string | false | none | The booking index name |
| milestones | Public_Entities_Milestone | false | none | none |
Public_Entities_BookingEvent
{
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"template_name": "string",
"template_variables": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
| user | Public_Entities_User | false | none | none |
| template_name | string | false | none | The template name |
| template_variables | object | false | none | All template_variables |
Public_Entities_PurchaseOrder
{
"id": 0,
"url": "string",
"purchase_order_number": "string",
"seller": {
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
},
"organization": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
},
"buyer": {
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
},
"incoterm": {
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
},
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"ex_factory_date": "2019-08-24T14:15:22Z",
"order_date": "2019-08-24T14:15:22Z",
"public_po_link": "string",
"cargo_ready_date": "2019-08-24T14:15:22Z",
"purchase_order_lines": [
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
],
"total_volume_cbm": 0,
"total_weight_kg": 0,
"to_plan": true,
"original_po_document": {
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"purchase_order_events": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
],
"exceptional": true,
"info_requests": [
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{}
],
"full_text": "string"
}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"shipments": [
{
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
}
]
}
Public_Entities_PurchaseOrder model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| url | string | true | none | The url to this purchase order |
| purchase_order_number | string | true | none | The purchase order's company-unique identifier |
| seller | object | true | none | The seller address and organization |
| » address | Public_Entities_AddressSeller | false | none | none |
| » organization | Public_Entities_OrganizationShort | false | none | none |
| buyer | Public_Entities_OrganizationShort | true | none | none |
| incoterm | Public_Entities_Incoterm | false | none | Public_Entities_Incoterm model |
| loading_port | Public_Entities_Port | false | none | none |
| ex_factory_date | string(date-time) | false | none | The ex-factory date |
| order_date | string(date-time) | false | none | The order date |
| public_po_link | string | false | none | Publik link for particular PO |
| cargo_ready_date | string(date-time) | false | none | The cargo ready date |
| purchase_order_lines | [Public_Entities_PurchaseOrderLine] | false | none | The purchase order lines |
| total_volume_cbm | number(float) | false | none | The total volume in cubed meters |
| total_weight_kg | number(float) | false | none | The total weight in kilograms |
| to_plan | boolean | false | none | Is true if at least 1 purchase order line is not associated with a shipment |
| original_po_document | Public_Entities_OrganizationDocument | false | none | none |
| purchase_order_events | [Public_Entities_PurchaseOrderEvent] | false | none | The purchase order events ordered from new to old |
| exceptional | boolean | false | none | Is exceptional? |
| info_requests | [Public_Entities_PurchaseOrderInfoRequest] | false | none | Purchase Order info requests |
| sla_checkpoints | [Public_Entities_SLACheckpoint] | false | none | The SLA checkpoints for this Purchase Order. |
| shipments | [Public_Entities_ShipmentShort] | false | none | All shipments linked to this purchase order |
Public_Entities_AddressSeller
{
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| url | string | true | none | The url to this address |
| name | string | true | none | The name |
| address | string | false | none | Street address. |
| postal_code | string | false | none | The postal code |
| city | string | false | none | The city |
| country | Public_Entities_Country | true | none | Public_Entities_Country model |
| string | false | none | The email address | |
| phone | string | false | none | The phone number |
Public_Entities_OrganizationShort
{
"id": 0,
"name": "string",
"preferred_shipment_role_id": "string",
"role_code": "string",
"manageable": true,
"logo": "string",
"role": "string",
"default_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | The name of the organization |
| preferred_shipment_role_id | string | true | none | The role name of the preferred shipment role |
| role_code | string | true | none | Code of the organziation role |
| manageable | boolean | true | none | When true then the organization can be added as a shipment collaborator |
| logo | string | false | none | URL of the organization logo |
| role | string | true | none | The role name of the connection |
| default_address | Public_Entities_AddressShort | true | none | none |
Public_Entities_AddressShort
{
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| url | string | true | none | The url to this address |
| name | string | true | none | The address name |
| address | string | false | none | Street street name |
| postal_code | string | false | none | The postal code |
| city | string | false | none | The city |
| country | Public_Entities_Country | true | none | Public_Entities_Country model |
| string | false | none | The email address | |
| phone | string | false | none | The phone number |
| vat_number | string | false | none | The VAT number |
| eori_number | string | false | none | The EORI number |
| comment | string | false | none | Additional information about the address. |
| default | boolean | false | none | Whether this is the default shipping address. |
Public_Entities_Incoterm
{
"id": 0,
"priority": 0,
"code": "string",
"name": "string",
"role_services": [
null
]
}
Public_Entities_Incoterm model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier for this incoterm. |
| priority | integer(int32) | false | none | The priority. |
| code | string | true | none | Incoterm code. |
| name | string | true | none | Descriptive incoterm name. |
| role_services | [any] | false | none | Services per shipment role |
Public_Entities_PurchaseOrderLine
{
"id": 0,
"url": "string",
"booking_lines": {
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
},
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"status": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| url | string | true | none | The url to this purchase order line |
| booking_lines | Public_Entities_BookingLine | false | none | none |
| product_code | string | false | none | The product code |
| product_name | string | false | none | The product name |
| units_ordered | integer(int32) | true | none | The amount of ordered units |
| status | string | false | none | The status of the order line |
Public_Entities_BookingLine
{
"id": 0,
"url": "string",
"weight_kg": 0,
"volume_cbm": 0,
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| url | string | true | none | The url to this booking line |
| weight_kg | number(float) | false | none | The weight in kilograms |
| volume_cbm | number(float) | false | none | The volume in cubic meters |
| shipment | Public_Entities_ShipmentShort | false | none | none |
| booking | Public_Entities_BookingShort | false | none | none |
Public_Entities_OrganizationDocument
{
"id": 0,
"original_filename": "string",
"download_url": "string",
"created_at": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier of the document. |
| original_filename | string | true | none | The original file name when it was uploaded. |
| download_url | string | false | none | Download URL. Direct link to download document. |
| created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
Public_Entities_PurchaseOrderEvent
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"exceptional": true,
"template_name": "string",
"template_variables": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| created_at | string(date-time) | true | none | The point in time when this entity was created in ISO 8601 format |
| user | Public_Entities_User | false | none | none |
| exceptional | boolean | false | none | Is exceptional? |
| template_name | string | false | none | The template name |
| template_variables | object | false | none | All template variables |
Public_Entities_PurchaseOrderInfoRequest
{
"to_email_address": "string",
"sent_at": "2019-08-24T14:15:22Z",
"additional_message": "string",
"reminder_sent_at": "2019-08-24T14:15:22Z",
"response_received_at": "2019-08-24T14:15:22Z",
"marked_no_response_at": "2019-08-24T14:15:22Z",
"email_bounced": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| to_email_address | string | false | none | The email address where the information request is sent to. |
| sent_at | string(date-time) | true | none | When the email was sent, in ISO 8601 format |
| additional_message | string | false | none | Extra information from to consignee to the supplier. |
| reminder_sent_at | string(date-time) | false | none | When the reminder email was sent, in ISO 8601 format. |
| response_received_at | string(date-time) | false | none | When the supplier responded to the update request, in ISO 8601 format. |
| marked_no_response_at | string(date-time) | false | none | When the PO was marked with supplier not responding exception, in ISO 8601 format. |
| email_bounced | boolean | false | none | A flag indicating if the email has bounced or not. |
Public_Entities_Milestone
{
"id": 0,
"name": "string",
"code": "string",
"reached": true,
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"status": "string",
"booking_level": true,
"container_level": true,
"tasks": {
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | Name of the milestone. |
| code | string | true | none | Code of the milestone. |
| reached | boolean | false | none | Is milestome reached? |
| start_date | string(date) | false | none | Milestone start date |
| due_date | string(date) | false | none | Milestone due date |
| status | string | false | none | Milestone status |
| booking_level | boolean | false | none | Is booking level? |
| container_level | boolean | true | none | Is container level? |
| tasks | Public_Entities_Task | false | none | none |
Public_Entities_Task
{
"id": 0,
"booking": {
"id": 0,
"url": "string",
"booking_reference": "string",
"booking_index": "string",
"shipper_name": "string",
"consignee_name": "string"
},
"container": {
"id": 0,
"status": "string",
"number": "string",
"url": "string",
"type": "string",
"type_name": "string",
"container_index": "string",
"container_event_exceptions": [
"string"
],
"pod_customs_documents_present": false,
"pod_customs_inspection_status": "string",
"pod_customs_inspection_type": "string",
"discharged_at": "2019-08-24T14:15:22Z",
"shared_reference": "string"
},
"shipment": {
"id": 0,
"reference": "string",
"our_reference": "string",
"internal_reference": "string",
"url": "string",
"public_shipment_link": "string",
"port_pair": {
"id": 0,
"loading_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"discharge_port": {
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
},
"tradelane": "string"
},
"estimated_departure_date": "2019-08-24",
"estimated_arrival_date": "2019-08-24",
"destination_demurrage_starting_from": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"resolved": "2019-08-24T14:15:22Z",
"task_type": {
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
},
"task_status": {
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
},
"possible_task_statuses": [
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
],
"milestone": {},
"document_type_code": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| booking | Public_Entities_BookingShort | false | none | none |
| container | Public_Entities_ContainerShort | false | none | none |
| shipment | Public_Entities_ShipmentShort | false | none | none |
| created_at | string(date-time) | true | none | The point in time when this entity was created, in ISO 8601 format |
| updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| due_date | string(date-time) | false | none | The point in time when this task is due, in ISO 8601 format |
| resolved | string(date-time) | false | none | The resolved datetime, in ISO 8601 format |
| task_type | Public_Entities_TaskType | false | none | none |
| task_status | Public_Entities_TaskStatus | false | none | none |
| possible_task_statuses | [Public_Entities_TaskStatus] | false | none | The task possible statuses |
| milestone | object | false | none | The milestone |
| document_type_code | string | false | none | none |
Public_Entities_TaskType
{
"id": 0,
"name": "string",
"code": "string",
"description": "string",
"column_display_name": "string",
"column_display_abbreviation": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | The name |
| code | string | true | none | The code |
| description | string | false | none | The description |
| column_display_name | string | false | none | Column name |
| column_display_abbreviation | string | false | none | Column abbreviation |
Public_Entities_TaskStatus
{
"id": 0,
"name": "string",
"order": 0,
"color": "string",
"icon": "string",
"shortcut": "string",
"task_status_type": {
"id": 0,
"name": "string",
"code": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | The name |
| order | integer(int32) | false | none | The order of the task status |
| color | string | false | none | The background color of the task status |
| icon | string | false | none | The corresponding icon |
| shortcut | string | false | none | Shortcut of the name(optional) |
| task_status_type | Public_Entities_TaskStatusType | false | none | none |
Public_Entities_TaskStatusType
{
"id": 0,
"name": "string",
"code": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | The name |
| code | string | true | none | The code |
patchV1ContainersIdConfirmDatetime
{
"service_type": "pickup"
}
Confirms pickup/delivery time
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| service_type | string | true | none | The type of date you want to confirm: pickup or delivery. |
Enumerated Values
| Property | Value |
|---|---|
| service_type | pickup |
| service_type | delivery |
patchV1ContainersIdAssignReference
{
"reference": "string",
"service_type": "pickup"
}
Assigns a reference to the container pickup/delivery
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| reference | string | true | none | Reference the trucker will give when picking-up or delivering the container respectively. |
| service_type | string | true | none | The type of reference you want to assign: pickup or delivery. |
Enumerated Values
| Property | Value |
|---|---|
| service_type | pickup |
| service_type | delivery |
patchV1ContainersIdAssignDatetime
{
"datetime_from": "2019-08-24T14:15:22Z",
"datetime_to": "2019-08-24T14:15:22Z",
"service_type": "pickup"
}
Assigns a datetime for pickup/delivery to the container
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| datetime_from | string(date-time) | true | none | Start of the datetime interval. |
| datetime_to | string(date-time) | true | none | End of the datetime interval. |
| service_type | string | true | none | The type of date you want to assign: pickup or delivery. |
Enumerated Values
| Property | Value |
|---|---|
| service_type | pickup |
| service_type | delivery |
patchV1ContainersIdAssignAddress
{
"address_id": 0,
"service_type": "pickup"
}
Assigns a pickup/delivery address to the container
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| address_id | integer(int32) | true | none | ID of the address to be assigned. |
| service_type | string | true | none | The type of address you want to assign: pickup or delivery. |
Enumerated Values
| Property | Value |
|---|---|
| service_type | pickup |
| service_type | delivery |
postV1Addresses
{
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"vat_number": "string",
"eori_number": "string",
"country_id": 0,
"phone": "string",
"email": "string",
"comment": "string",
"port_ids": [
0
],
"preferred_modalities": [
"string"
],
"visiting_instructions": [
"string"
]
}
Creates an address
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | Name of the address. |
| address | string | false | none | Street address. |
| postal_code | string | false | none | The postal code (ZIP code). |
| city | string | false | none | The city name. |
| vat_number | string | false | none | VAT identification number. |
| eori_number | string | false | none | Economic Operators Registration and Identification number. |
| country_id | integer(int32) | true | none | Country id. |
| phone | string | false | none | Phone number. |
| string | false | none | Email address. | |
| comment | string | false | none | Comment. |
| port_ids | [integer] | false | none | An array of the IDs of the preferred ports for this address. |
| preferred_modalities | [string] | false | none | Preferred modalities as an array of string, i.e.: ["sea", "air", "road", "rail", "barge"] |
| visiting_instructions | [string] | false | none | Visiting instructions. |
patchV1AddressesId
{
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"vat_number": "string",
"eori_number": "string",
"country_id": 0,
"phone": "string",
"email": "string",
"comment": "string",
"port_ids": [
0
],
"preferred_modalities": [
"string"
],
"visiting_instructions": [
"string"
]
}
Updates an address by ID
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | false | none | Name of the address. |
| address | string | false | none | Street address. |
| postal_code | string | false | none | The postal code (ZIP code). |
| city | string | false | none | The city name. |
| vat_number | string | false | none | VAT identification number. |
| eori_number | string | false | none | Economic Operators Registration and Identification number. |
| country_id | integer(int32) | false | none | Country id. |
| phone | string | false | none | Phone number. |
| string | false | none | Email address. | |
| comment | string | false | none | Comment. |
| port_ids | [integer] | false | none | An array of the IDs of the preferred ports for this address. |
| preferred_modalities | [string] | false | none | Preferred modalities as an array of string, i.e.: ["sea", "air", "road", "rail", "barge"] |
| visiting_instructions | [string] | false | none | Visiting instructions. |
Public_Entities_Contact
{
"id": 0,
"name": "string",
"email": "string",
"phone": "string",
"company_address_id": 0,
"company_name": "string",
"company_address": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"organization_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"comment": "string"
}
Public_Entities_Contact model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | The name |
| string | true | none | The email address | |
| phone | string | true | none | The phone number |
| company_address_id | integer(int32) | false | none | The identifier of the company address |
| company_name | string | false | none | The company name |
| company_address | Public_Entities_Address | false | none | Public_Entities_Address model |
| organization_id | integer(int32) | true | none | The identifier of the organization |
| updated_at | string(date-time) | true | none | The point in time when this entity was last updated, in ISO 8601 format |
| comment | string | false | none | Additional information about the contact |
postV1Contacts
{
"name": "string",
"email": "string",
"phone": "string",
"company_name": "string",
"company_address": "string",
"company_address_id": 0,
"organization_id": 0
}
Creates a contact
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | Name of the address. |
| string | true | none | Email address. | |
| phone | string | true | none | Phone number. |
| company_name | string | false | none | Company name. |
| company_address | string | false | none | Company address. |
| company_address_id | integer(int32) | true | none | Company address id. |
| organization_id | integer(int32) | false | none | Organization id. |
patchV1ContactsId
{
"name": "string",
"email": "string",
"phone": "string",
"company_name": "string",
"company_address": "string",
"company_address_id": 0,
"organization_id": 0
}
Updates a contact by ID
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | false | none | Name of the address. |
| string | false | none | Email address. | |
| phone | string | false | none | Phone number. |
| company_name | string | false | none | Company name. |
| company_address | string | false | none | Company address. |
| company_address_id | integer(int32) | false | none | Company address id. |
| organization_id | integer(int32) | false | none | Organization id. |
Public_Entities_PackageType
{
"id": 0,
"code": "string",
"name": "string",
"description": "string",
"default_length_mm": 0,
"default_width_mm": 0,
"default_height_mm": 0,
"default_type": true
}
Public_Entities_PackageType model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | The unique Shypple identifier for this package type. |
| code | string | true | none | The code |
| name | string | true | none | The name |
| description | string | false | none | The description |
| default_length_mm | integer(int32) | false | none | The default length in millimeters |
| default_width_mm | integer(int32) | false | none | The default width in millimeters |
| default_height_mm | integer(int32) | false | none | The default height in millimeters |
| default_type | boolean | true | none | Is default package type? |
postV1Bookings
{
"shipment_id": 0,
"booking_reference": "string",
"cargo_ready_date": "2019-08-24",
"incoterm_code": "string",
"consignee_as_notify_party": true
}
Create a new booking
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| shipment_id | integer(int32) | true | none | Shipment id. |
| booking_reference | string | false | none | The booking reference for the booking. |
| cargo_ready_date | string(date) | false | none | Cargo ready date, in ISO 8601 format: YYYY-MM-DD. |
| incoterm_code | string | false | none | Incoterm code (see GET /public/v1/incoterms). |
| consignee_as_notify_party | boolean | false | none | Is consignee also the notify party? |
patchV1BookingsId
{
"booking_reference": "string",
"cargo_ready_date": "2019-08-24",
"incoterm_code": "string",
"consignee_as_notify_party": true
}
Update an existing booking
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| booking_reference | string | false | none | The booking reference for the booking. |
| cargo_ready_date | string(date) | false | none | Cargo ready date, in ISO 8601 format: YYYY-MM-DD. |
| incoterm_code | string | false | none | Incoterm code (see GET /public/v1/incoterms). |
| consignee_as_notify_party | boolean | false | none | Is consignee also the notify party? |
patchV1BookingsIdAssignAddress
{
"address_id": 0,
"booking_party": "shipper"
}
Assign an address to a booking
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| address_id | integer(int32) | true | none | Address id. |
| booking_party | string | true | none | The booking party. |
Enumerated Values
| Property | Value |
|---|---|
| booking_party | shipper |
| booking_party | consignee |
| booking_party | notify_party |
patchV1BookingsIdAssignContact
{
"contact_id": 0,
"booking_party": "shipper"
}
Assign a contact to a booking
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contact_id | integer(int32) | true | none | Contact id, which must belong to the shipment address of the booking |
| booking_party | string | true | none | The booking party. |
Enumerated Values
| Property | Value |
|---|---|
| booking_party | shipper |
| booking_party | consignee |
| booking_party | notify_party |
patchV1BookingsIdAssignAddressAndContact
{
"address_id": 0,
"contact_id": 0,
"booking_party": "shipper"
}
Assign an address and a contact to a booking
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| address_id | integer(int32) | true | none | Address id. |
| contact_id | integer(int32) | true | none | Contact id, which must belong to the provided address. |
| booking_party | string | true | none | The booking party. |
Enumerated Values
| Property | Value |
|---|---|
| booking_party | shipper |
| booking_party | consignee |
| booking_party | notify_party |
putV1PurchaseOrdersId
{
"purchase_order_number": "string",
"seller_address_id": 0,
"seller_address_name": "string",
"incoterm_code": "string",
"loading_port_code": "string",
"loading_port_name": "string",
"ex_factory_date": "2019-08-24",
"order_date": "2019-08-24",
"cargo_ready_date": "2019-08-24",
"purchase_order_lines": [
{
"id": 0,
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"booking_lines": [
{
"weight_kg": 0,
"volume_cbm": 0
}
]
}
]
}
Update an existing purchase order
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| purchase_order_number | string | false | none | The unique purchase order number. |
| seller_address_id | integer(int32) | false | none | The address ID of the seller (see GET /public/v1/addresses). |
| seller_address_name | string | false | none | The address name of the seller (see GET /public/v1/addresses). |
| incoterm_code | string | false | none | Incoterm code (see GET /public/v1/incoterms). |
| loading_port_code | string | false | none | The 5-character UN/LOCODE identifier of the loading port (e.g. NLRTM). https://www.unece.org/cefact/locode/service/location.html |
| loading_port_name | string | false | none | Name of the loading port (e.g. Rotterdam). https://www.unece.org/cefact/locode/service/location.html |
| ex_factory_date | string(date) | false | none | The EX Factory Date in ISO 8601 format: YYYY-MM-DD. |
| order_date | string(date) | false | none | The Order Date in ISO 8601 format: YYYY-MM-DD. |
| cargo_ready_date | string(date) | false | none | The Cargo Ready Date in ISO 8601 format: YYYY-MM-DD. |
| purchase_order_lines | [object] | false | none | A list of purchase order lines |
| » id | integer(int32) | false | none | Leave the id blank to create a new purchase order line. |
| » product_code | string | false | none | The product code. |
| » product_name | string | false | none | The product name. |
| » units_ordered | integer(int32) | false | none | The amount of units ordered. |
| » booking_lines | [object] | false | none | The booking lines |
| »» weight_kg | number(float) | false | none | The weight in kilograms. |
| »» volume_cbm | number(float) | false | none | The volume in cubed meters. |
postV1PurchaseOrders
{
"purchase_order_number": "string",
"seller_address_id": 0,
"seller_address_name": "string",
"incoterm_code": "string",
"loading_port_code": "string",
"loading_port_name": "string",
"ex_factory_date": "2019-08-24",
"order_date": "2019-08-24",
"cargo_ready_date": "2019-08-24",
"purchase_order_lines": [
{
"product_code": "string",
"product_name": "string",
"units_ordered": 0,
"booking_lines": [
{
"weight_kg": 0,
"volume_cbm": 0
}
]
}
]
}
Create a new purchase order
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| purchase_order_number | string | true | none | The unique purchase order number. |
| seller_address_id | integer(int32) | false | none | The address ID of the seller (see GET /public/v1/addresses). |
| seller_address_name | string | false | none | The address name of the seller (see GET /public/v1/addresses). |
| incoterm_code | string | false | none | Incoterm code (see GET /public/v1/incoterms). |
| loading_port_code | string | false | none | The 5-character UN/LOCODE identifier of the loading port (e.g. NLRTM). https://www.unece.org/cefact/locode/service/location.html |
| loading_port_name | string | false | none | Name of the loading port (e.g. Rotterdam). https://www.unece.org/cefact/locode/service/location.html |
| ex_factory_date | string(date) | false | none | The EX Factory Date in ISO 8601 format: YYYY-MM-DD. |
| order_date | string(date) | false | none | The Order Date in ISO 8601 format: YYYY-MM-DD. |
| cargo_ready_date | string(date) | false | none | The Cargo Ready Date in ISO 8601 format: YYYY-MM-DD. |
| purchase_order_lines | [object] | false | none | A list of purchase order lines |
| » product_code | string | false | none | The product code. |
| » product_name | string | false | none | The product name. |
| » units_ordered | integer(int32) | false | none | The amount of units ordered. |
| » booking_lines | [object] | false | none | The booking lines |
| »» weight_kg | number(float) | false | none | The weight in kilograms. |
| »» volume_cbm | number(float) | false | none | The volume in cubed meters. |
Public_Entities_Connection
{
"organization_id": 0,
"name": "string",
"logo": "string",
"role": "string",
"is_preferred_forwarder": true,
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"last_seen": "2019-08-24T14:15:22Z",
"users": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"url": "string",
"role_code": "string",
"manageable": true,
"addresses": {
"id": 0,
"url": "string",
"name": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"email": "string",
"phone": "string",
"vat_number": "string",
"eori_number": "string",
"comment": "string",
"default": true,
"connection": {
"id": 0,
"name": "string",
"prefix": "string",
"configured_po_upload": true,
"logo": "string",
"role_code": "string",
"default_address": {},
"preferred_shipment_role_id": 0,
"preferred_forwarder_id": 0,
"public_documents": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"ports": [
{
"id": 0,
"name": "string",
"code": "string",
"display_name": "string",
"type": "string",
"country": {
"id": 0,
"name": "string",
"title": "string",
"code": "string",
"trade_zone": "string"
},
"time_zone": "string"
}
],
"preferred_modalities": [
"string"
],
"sla_checkpoints": [
{
"id": 0,
"name": "string",
"dt_days": 0,
"has_info_requests": true,
"owner": {
"id": 0,
"full_name": "string",
"email": "string",
"organization_name": "string",
"last_active": "2019-08-24T14:15:22Z",
"out_of_office_till": "2019-08-24T14:15:22Z",
"avatar": "string"
},
"sla_checkpoint_type": {
"id": 0,
"code": "string",
"name": "string"
},
"sla_checkpoint_value": {
"id": 0,
"date_field": "string",
"description": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"sla_checkpoint_addresses": {
"id": 0,
"automated_alert": true,
"address": {}
},
"due_date_message_status": {
"due_date": "2019-08-24",
"message_status": "string"
}
}
],
"full_text": "string"
},
"preferred_shipment_role_id": "string"
}
Public_Entities_Connection model
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organization_id | integer(int32) | true | none | The unique Shypple identifier |
| name | string | true | none | Organization name of the Connection |
| logo | string | false | none | URL of the organization logo |
| role | string | true | none | The role name of the connection |
| is_preferred_forwarder | boolean | false | none | When true then the organization is preferred freight forwarder |
| country | Public_Entities_Country | true | none | Public_Entities_Country model |
| last_seen | string(date-time) | true | none | The timestamp when this entity was seen last time in ISO 8601 format |
| users | Public_Entities_User | true | none | none |
| url | string | true | none | The url to this connection |
| role_code | string | true | none | Code of the organziation role |
| manageable | boolean | true | none | When true then the organization can be added as a shipment collaborator |
| addresses | Public_Entities_Address | true | none | Public_Entities_Address model |
| preferred_shipment_role_id | string | true | none | The ID of preferred shipment role of this connection. |