API DOCUMENTATION
    Try Unleashed Now Sandbox

    Sales Shipments

    The SalesShipments resource allows shipments on a Sales Order to be listed and viewed. An individual shipment details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI.

    The full range of URIs and HTTP Verbs supported are:

    Operation HTTP Action
    List all Sales Shipments GET /SalesShipments
    View the Sales Shipments for a specific page GET /SalesShipments/{pageNumber}
    GET /SalesShipments/Page/{pageNumber}
    View a Sales Shipment with the specified Guid GET /SalesShipments/{id}
    Create a new Sales Shipment POST /SalesShipments
    Update a Sales Shipment PUT /SalesShipments/{id}
    Delete a Sales Shipment DELETE /SalesShipments/{id}
    Delete a Sales Shipment Line DELETE /SalesShipments/Lines/{id}

    GET Sales Shipments

    Available Filters for GET Sales Shipments
    Filter Description
    endDate Returns shipments created before a specified date.
    modifiedSince Returns shipments created or edited after a specified date.
    orderBy Permitted value: ShipmentNumber. Defaults to LastModifiedOn if not supplied.
    orderNumber Returns all shipments for the specified order number. If specified, it overrides all other filters.
    pageSize Specifies the page size for pagination. Default page size is 200 shipments.

    Note: Requesting large numbers of shipments can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
    serialBatch False by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed.
    shipmentStatus Returns shipments for the specified status.
    sort Works in conjunction with orderBy to sort the list in ascending or descending order. Permitted values are asc (default) or desc.
    startDate Returns shipments created after a specified date.
    warehouseCode Returns sales shipments with the specified warehouse code.
    Note: Date filters should be provided in the ISO format YYYY-MM-DD.

    Filters are used by adding the filter and value to the URI:
    • /SalesShipments?orderStatus=Dispatched&startDate=2012-01-01&orderBy=ShipmentNumber&sort=desc

    Note: Default ordering is done by LastModifiedOn descending.

    Available Fields for GET Sales Shipments
    Property Type Length Notes
    Comments String 500 Can be edited after the sales shipment is dispatched.
    CreatedBy String 50
    CreatedOn DateTime
    Customer Customer collection
    CustomerRef String 500
    DeliveryCity String 500
    DeliveryContact DeliveryContact collection
    DeliveryCountry String 500
    DeliveryInstruction String 500
    DeliveryName String 500
    DeliveryPostCode String 50
    DeliveryRegion String 500
    DeliveryStreetAddress String 500
    DeliveryStreetAddress2 String 500
    DeliverySuburb String 500
    DispatchDate DateTime
    Guid Guid Unique identifier. Can only be set when adding a record.
    Incoterm String 3
    LastModifiedBy String 50
    LastModifiedOn DateTime
    NatureOfTransactionCode String 2
    NumberOfPackages Integer
    OrderNumber String 20
    OrderGuid Guid
    ReceiverEORI String 20
    SalesShipmentLines SalesShipmentLine collection
    ShipmentNumber String 25
    ShipmentStatus String 20
    ShipmentWeight Integer
    ShippingCompany ShippingCompany collection Can be edited after the sales shipment is dispatched.
    ShipperEORI String 20
    TotalCommercialValue Decimal
    TrackingNumber String 50 Can be edited after the sales shipment is dispatched.
    Warehouse Warehouse collection

    Note: Default ordering is done by SalesOrderLineNumber ascending.

    Available Fields for Customer
    Property Type Length Notes
    CustomerCode String 500
    CustomerName String 500
    Guid Guid Unique identifier. Can only be set when adding a record.
    LastModifiedOn DateTime
    Available Fields for Delivery Contact
    Property Type Length Notes
    EmailAddress String 500
    FirstName String 500
    Guid Guid Unique identifier. Can only be set when adding a record.
    LastName String 500
    MobilePhone String 500
    OfficePhone String 500
    PhoneNumber String 500
    Available Fields for Shipping Company
    Property Type Length Notes
    Guid Guid Unique identifier. Can only be set when adding a record.
    Name String 256
    Available Fields for Warehouse
    Property Type Length Notes
    Guid Guid Unique identifier. Can only be set when adding a record.
    WarehouseCode String 15
    WarehouseName String 100
    Available Fields for Sales Shipment Line
    Property Type Length Notes
    BatchNumbers BatchNumber collection
    CommercialMonetaryValue Decimal
    CreatedBy String 50
    CreatedOn DateTime
    Guid Guid Unique identifier. Can only be set when adding a record.
    LastModifiedBy String 50
    LastModifiedOn DateTime
    LineNumber Integer Line number maps to SalesOrderLineNumber
    Product Product collection
    SalesOrderLineId Integer
    SalesOrderLineNumber Integer
    SerialNumbers SerialNumber collection
    ShipmentQty Decimal
    UnitCost Decimal
    UnitCostAtTimeOfDispatch Decimal
    Available Fields for Batch Number
    Property Type Length Notes
    ExpiryDate Date
    Guid Guid Unique identifier. Can only be set when adding a record.
    LastModifiedOn DateTime
    Number String 50
    Quantity Decimal
    Available Fields for Product
    Property Type Length Notes
    Guid Guid Unique identifier. Can only be set when adding a record.
    ProductCode String 100
    ProductDescription String 500
    Available Fields for Serial Number
    Property Type Length Notes
    Guid Guid Unique identifier. Can only be set when adding a record.
    Identifier String 50
    LastModifiedOn DateTime

    Examples for Response GET /SalesShipments

    show xml example
    show json example

    POST / PUT Sales Shipments

    Available Filters for POST/PUT Sales Shipments
    Filter Description
    serialBatch If set to true:

    For a POST request, the serial and batch numbers are assigned provided they are already assigned to the Sales Order.

    For a PUT request, the serial and batch numbers are assigned regardless of whether they are assigned on the Sales Order.
    Available Fields for POST/PUT Sales Shipments
    Property Type Length POST PUT Notes
    Comments String 500 Optional Optional
    DispatchDate DateTime yyyy-mm-dd Optional Optional
    Guid Guid Required Required Unique identifier. Can only be set when adding a record.
    OrderNumber String 20 Required N/A
    SalesShipmentLines SalesShipmentLine collection Required Required At least one shipment line is required.
    ShipmentStatus String 20 Required Required when order management is enabled.
    ShippingCompany ShippingCompany collection Optional Optional
    TrackingNumber String 50 Optional Optional
    Available Fields for Shipping Company

    Note: At a minimum, a valid Guid or Name is required.

    Property Type Length POST PUT Notes
    Guid Guid Optional Optional
    Name String 256 Optional Optional
    Available Fields for Sales Shipment Line
    Property Type Length POST PUT Notes
    BatchNumbers BatchNumber collection Optional Optional If the serialBatch filter value is set to true:

    For POST, the batch numbers must match those assigned to the Sales Order.

    For PUT, the batch numbers provided must be valid and will be assigned to the shipment regardless of any batch numbers assigned to the Sales Order.
    Guid Guid N/A Optional If the Guid is set, it will update the existing lines instead of recreating them.
    Product Product collection Required Required
    SalesOrderLineNumber Integer Optional Optional Sales Order line mapping. If the sales order line is specified, it will validate if the product for shipment line is the same as the product of the sales order line.
    SerialNumbers SerialNumber collection Optional Optional If the serialBatch filter value is set to true:

    For POST, the serial numbers must match those assigned to the Sales Order.

    For PUT, the serial numbers provided must be valid and will be assigned to the shipment regardless of any serial numbers assigned to the Sales Order.
    ShipmentQty Decimal Required Required
    Available Fields for Batch Number

    Note: At a minimum, a valid Guid or Number is required.

    Property Type Length POST PUT Notes
    ExpiryDate Date Optional Optional
    Guid Guid Optional Optional
    Number String 50 Optional Optional
    Quantity Decimal Required Required
    Available Fields for Serial Number
    Property Type Length POST PUT Notes
    Guid Guid Optional Optional
    Identifier String 50 Required Optional
    Available Fields for Product
    Property Type Length POST PUT Notes
    Guid Guid Optional Optional Unique identifier. Can only be set when adding a record.
    ProductCode String 100 Required Required

    Examples for Request POST /SalesShipments

    show xml example
    show json example

    Examples for Request PUT /SalesShipments/{id}

    show xml example
    show json example

    DELETE SalesShipments

    Examples for Response DELETE /SalesShipments/{id}

    show xml example
    show json example

    Use the API Sandbox to see how the object is rendered in JSON or XML.

    Note: An Unleashed account is required before you can use the API Sandbox.

    Trial accounts are also allowed to connect to the API.
    You can register a new account here: Register.