Shipments
Collection of shipments.
Endpoint
GET shipments
Parameters
sender_warehouseid
Filter on warehouseid for sender
receiver_warehouseid
Filter on warehouseid for receiver
archived
Filter on archived flag. ValueDescription10All20Active30ArchivedDefault: 20
start
The index of the item to start fromDefault: 0
num
The number of items returnedDefault: 10
fields
Comma separated list of fields to return. Use this to query only the fields you are using. See shipment for all fields. Default fields:
shipmentidshipmentstateexternaliddatenewdateintransitdatereceiveddatecancelleddateestimatedpickupdateestimateddeliverysender_warehouseidsender_namereceiver_warehouseidreceiver_namecarrier_namecarrier_reference
HTTP Response Status
200
OK. Returns data (see below).
400
Bad Request. Invalid syntax, missing required argument or invalid request.
401
Unauthorized. Authorization failed.
404
Resource not found. The url is invalid.
429
Too Many Requests.
500
Internal Server Error.
Returns
Returns an envelope with items of type shipment.
Example
Request
GET https://api.mysitoo.com/v2/accounts/1500/shipments.json?archived=10&num=2
Response
{
"totalcount": 2,
"items": [
{
"shipmentid": 10000,
"shipmentstate": 0,
"externalid": "",
"datenew": 1520757947,
"dateintransit": null,
"datereceived": null,
"datecancelled": null,
"dateestimatedpickup": null,
"dateestimateddelivery": null,
"sender_warehouseid": null,
"sender_name": "Central Warehouse",
"receiver_warehouseid": 1,
"receiver_name": "City Concept Store",
"carrier_name": "DHL",
"carrier_reference": "52254195678"
},
{
"shipmentid": 10001,
"shipmentstate": 10,
"externalid": "",
"datenew": 1520759003,
"dateintransit": 1520774467,
"datereceived": null,
"datecancelled": null,
"dateestimatedpickup": null,
"dateestimateddelivery": null,
"sender_warehouseid": null,
"sender_name": "Central Warehouse",
"receiver_warehouseid": 1,
"receiver_name": "City Concept Store",
"carrier_name": "DHL",
"carrier_reference": "52254191234"
}
]
}
Endpoint
POST shipments
Request body
See shipment for fields.
HTTP Response Status
200
OK. Returns data (see below).
400
Bad Request. Invalid syntax, missing required argument or invalid request.
401
Unauthorized. Authorization failed.
404
Resource not found. The url is invalid.
429
Too Many Requests.
500
Internal Server Error.
Returns
Returns shipmentid if successful.
Example
Request
POST https://api.mysitoo.com/v2/accounts/1500/shipments.json
{
"shipmentstate": 10,
"comment": "New shipment",
"receiver_warehouseid": 1,
"receiver_name": "City Concept Store",
"carrier_name": "DHL",
"carrier_reference": "123456789",
"shipmentpackages": [
{
"shipmentpackageid": 1,
"barcode": "123456789"
}
],
"shipmentitems": [
{
"shipmentitemid": 1,
"shipmentpackageid": 1,
"sku": "sku-1",
"productname": "Product 1",
"quantity": 150,
"externalid": "12345-1"
},
{
"shipmentitemid": 2,
"shipmentpackageid": 1,
"sku": "sku-2",
"productname": "Product 2",
"quantity": 80,
"externalid": "12345-2"
}
]
}
Response
10002
Endpoint
GET shipments/{shipmentid}
HTTP Response Status
200
OK. Returns data (see below).
400
Bad Request. Invalid syntax, missing required argument or invalid request.
401
Unauthorized. Authorization failed.
404
Resource not found. The url is invalid.
429
Too Many Requests.
500
Internal Server Error.
Returns
Returns an item of type shipment.
Example
Request
GET https://api.mysitoo.com/v2/accounts/1500/shipments/10002.json
Response
{
"shipmentid": 10002,
"shipmentstate": 10,
"archived": false,
"externalid": "",
"barcode": "",
"comment": "New shipment",
"emailowner": "",
"emailreceivedby": "",
"datenew": 1550669772,
"dateintransit": 1550669772,
"datereceived": null,
"datecancelled": null,
"dateestimatedpickup": null,
"dateestimateddelivery": null,
"sender_warehouseid": null,
"sender_name": "",
"sender_address": "",
"sender_address2": "",
"sender_zip": "",
"sender_city": "",
"sender_state": "",
"sender_countryid": "",
"sender_referencename": "",
"sender_referenceemail": "",
"sender_referencemobile": "",
"sender_instructions": "",
"receiver_warehouseid": 1,
"receiver_name": "City Concept Store",
"receiver_address": "",
"receiver_address2": "",
"receiver_zip": "",
"receiver_city": "",
"receiver_state": "",
"receiver_countryid": "",
"receiver_referencename": "",
"receiver_referenceemail": "",
"receiver_referencemobile": "",
"receiver_instructions": "",
"carrier_name": "DHL",
"carrier_reference": "123456789",
"carrier_trackingurl": "",
"shipmentpackages": [
{
"shipmentpackageid": 1,
"barcode": "123456789",
"externalid": "",
"comment": ""
}
],
"shipmentitems": [
{
"shipmentitemid": 1,
"shipmentpackageid": 1,
"sku": "sku-1",
"productname": "Product 1",
"unitlabel": "",
"decimalunitquantity": null,
"quantity": 150,
"quantityreceived": 0,
"moneypricein": null,
"externalid": "12345-1"
},
{
"shipmentitemid": 2,
"shipmentpackageid": 1,
"sku": "sku-2",
"productname": "Product 2",
"unitlabel": "",
"decimalunitquantity": null,
"quantity": 80,
"quantityreceived": 0,
"moneypricein": null,
"externalid": "12345-2"
}
]
}
Endpoint
PUT shipments/{shipmentid}
Request body
See shipment for fields.
HTTP Response Status
200
OK. Returns data (see below).
400
Bad Request. Invalid syntax, missing required argument or invalid request.
401
Unauthorized. Authorization failed.
404
Resource not found. The url is invalid.
429
Too Many Requests.
500
Internal Server Error.
Returns
Returns true if successful.
Example
Request
PUT https://api.mysitoo.com/v2/accounts/1500/shipments/10002.json
{
"shipmentstate": 20,
"comment": "Received at Store"
}
Response
true