Introduction
Guides
API Reference
SPI CRM v2
SPI CRM v1
SPI Events
SPI Gift Card
SPI Payment
SPI Product Recommendations
SPI Product Search
Journals v3
Purchase Prices v3
Shipments v3

Shipments

Add Shipment

post /shipments
REQUEST BODY
object
shipment
posthttps://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 JSON
10002
HTTP Status Code Summary
200Returns shipmentid
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Shipments

get /shipments
PARAMETERS
shipmentid
array (integer)
query

Filter on shipmentid, use comma as separator for multiple values.

Example: /shipments?shipmentid=12345,12347,12335
any_warehouseid
array (integer)
query

Filter on warehouseid for sender or receiver. Note that if this filter is used, then the sender_warehouseid and receiver_warehouseid filters are ignored. Use comma as separator for multiple values.

sender_warehouseid
array (integer)
query

Filter on warehouseid for sender. Use comma as separator for multiple values.

receiver_warehouseid
array (integer)
query

Filter on warehouseid for receiver. Use comma as separator for multiple values.

archived
object
query

Filter on archived flag.

archivedfiltertype
Default: 20
start
integer
query

The index of the item to start from

Default: 0
num
integer
query

The number of items returned

Default: 10
fields
array (string)
query

Comma separated list of fields to return. Use this to query only the fields you are using. See shipment for all fields.

Default: [ "shipmentid", "shipmentstate", "externalid", "datenew", "dateintransit", "datereceived", "datecancelled", "dateestimatedpickup", "dateestimateddelivery", "sender_warehouseid", "sender_name", "receiver_warehouseid", "receiver_name", "carrier_name", "carrier_reference" ]
Example: /shipments?fields=shipmentid,shipmentstate,sender_warehouseid,receiver_warehouseid
Returns

Returns an envelope with items of type shipment.

shipment
gethttps://api.mysitoo.com/v2/accounts/1500/shipments.json?archived=10&num=2
RESPONSE JSON
{
  "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"
    }
  ]
}
HTTP Status Code Summary
200Returns an envelope with items of type shipment.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Shipment

get /shipments/{shipmentid}
PARAMETERS
shipmentid
integer
path
REQUIRED
Returns

Returns an item of type shipment.

shipment
gethttps://api.mysitoo.com/v2/accounts/1500/shipments/10002.json
RESPONSE JSON
{
  "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"
    }
  ]
}
HTTP Status Code Summary
200Returns an item of type shipment.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Update Shipment

put /shipments/{shipmentid}
PARAMETERS
shipmentid
integer
path
REQUIRED
REQUEST BODY
object
shipment
puthttps://api.mysitoo.com/v2/accounts/1500/shipments/10002.json
{
  "shipmentstate": 20,
  "comment": "Received at Store"
}
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Objects

archivedfiltertype
integer

  • 10 All
  • 20 Active
  • 30 Archived

money
string

Pattern: ^[-+]?[0-9]+\.[0-9]{2}$
Example: "123.00"

shipment
object

A shipment is the object used for handling shipments in Sitoo systems. Shipments are common to all sites.

PROPERTIES
shipmentid
integer
READ ONLY

ID of shipment in Sitoo.

shipmentstate
shipmentstate

State of shipment.

archived
boolean

Flag indicating archived shipment.

externalid
string

External ID for shipment.

barcode
string

Barcode used to identify this shipment. Needs to have a unique value.

comment
string

Comment for the shipment.

emailowner
string

The email of the owner of the shipment.

emailreceivedby
string

The email of the person responsible for processing the received shipment.

datenew
timestamp
READ ONLY

The date and time when the shipment was created.

dateintransit
timestamp
READ ONLY

The date and time when the shipment was set to shipmentstate InTransit. (If null, the state has never been set)

datereceived
timestamp
READ ONLY

The date and time when the shipment was set to shipmentstate Received. (If null, the state has never been set)

datecancelled
timestamp
READ ONLY

The date and time when the shipment was set to shipmentstate Cancelled. (If null, the state has never been set)

dateestimatedpickup
timestamp

The estimated date and time for pickup from sender or null if not set.

dateestimateddelivery
timestamp

The estimated date and time for delivery to receiver or null if not set.

sender_warehouseid
integer

The warehouseid in Sitoo for sender or null if not applicable.

sender_name
string

The name of the sender.

sender_address
string

Address for the sender.

sender_address2
string

Address 2 for the sender.

sender_zip
string

Zip for the sender.

sender_city
string

City for the sender.

sender_state
string

State for the sender.

sender_countryid
string

Country ID for the sender (2-letter ISO 3166).

sender_referencename
string

Reference name for the sender.

sender_referenceemail
string

Reference email for the sender.

sender_referencemobile
string

Reference mobile phone for the sender.

sender_instructions
string

Instructions for the sender.

receiver_warehouseid
integer

The warehouseid in Sitoo for receiver or null if not applicable.

receiver_name
string

The name of the receiver.

receiver_address
string

Address for the receiver.

receiver_address2
string

Address 2 for the receiver.

receiver_zip
string

Zip for the receiver.

receiver_city
string

City for the receiver.

receiver_state
string

State for the receiver.

receiver_countryid
string

Country ID for the receiver (2-letter ISO 3166).

receiver_referencename
string

Reference name for the receiver.

receiver_referenceemail
string

Reference email for the receiver.

receiver_referencemobile
string

Reference mobile phone for the receiver.

receiver_instructions
string

Instructions for the receiver.

carrier_name
string

The name of the carrier.

carrier_reference
string

The carrier reference for the shipment.

carrier_trackingurl
string

The carrier tracking url for the shipment.

shipmentpackages
array
(shipmentpackage)

The packages in this shipment. An array of shipmentpackage.

shipmentitems
array
(shipmentitem)

The items in this shipment. An array of shipmentitem.

shipmentitem
object

A shipment item is a row contained in a shipment. Can be grouped in shipmentpackage.

PROPERTIES
shipmentitemid
integer

Row ID for shipment item.

shipmentpackageid
integer

Reference to shipment package that this item belongs to.

sku
string

The SKU for this shipment item.

productname
string

The name of the product in this shipment item.

unitlabel
string

Unit (typically left blank) (e g "kg").

decimalunitquantity
string

Unit quantity if applicable, else null.

quantity
integer

The number of units in this shipment item.

quantityreceived
integer

The number of units received for this shipment.

moneypricein
money

The purchase price per unit for this shipment item or null. If entered it can be used for the warehouse stock transaction resulting from the shipment.

externalid
string

External ID for shipment item (if applicable).

shipmentpackage
object

A shipment package is an optional grouping of shipmentitem in a shipment.

PROPERTIES
shipmentpackageid
integer

ID of shipment package in Sitoo.

barcode
string

Barcode used to identify this package. Needs to have a unique value.

externalid
string

External ID for package.

comment
string

Comment for package.

shipmentstate
integer

  • 0 New
  • 10 InTransit
  • 20 Received
  • 100 Cancelled

timestamp
integer

Number of seconds since the Unix Epoch.

Copyright © 2024 Sitoo AB. All rights reserved.