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 of paginated SalesShipments GET /SalesShipments/Page/{pageNumber}
    View any sales shipment GET /SalesShipments/{id}
    Create a sales shipment POST /SalesShipments
    Update a sales shipment PUT /SalesShipments/{id}
    Delete a sales shipment DELETE /SalesShipments/{id}, DELETE /SalesShipments/Lines/{id}

    GET SalesShipments

    These filters can be used with the GET SalesShipments endpoint:

    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.

    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 SalesShipment:

    Property Type Length Notes
    Comments Nullable String 500 Can be edited after the sales shipment is dispatched.
    CreatedBy String 50  
    CreatedOn DateTime    
    Customer Customer    
    CustomerRef String 500  
    DeliveryCity String 500  
    DeliveryContact DeliveryContact    
    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 Nullable DateTime    
    Guid Guid   Unique identifier. Can only be set when adding a record.
    Incoterm Nullable String 3  
    LastModifiedBy String 50  
    LastModifiedOn Nullable DateTime    
    NatureOfTransactionCode Nullable String 2  
    NumberOfPackages Nullable Integer    
    OrderNumber String 20  
    OrderGuid Guid    
    ReceiverEORI Nullable String 20  
    SalesShipmentLines SalesShipmentLine    
    ShipmentNumber String 25  
    ShipmentStatus String 20  
    ShipmentWeight Nullable Integer    
    ShippingCompany Nullable ShippingCompany   Can be edited after the sales shipment is dispatched.
    SupplierEORI Nullable String 20  
    TotalCommercialValue Nullable Decimal    
    TrackingNumber Nullable String 50 Can be edited after the sales shipment is dispatched.
    Warehouse Warehouse    

    Note: Default ordering is done by SalesOrderLineNumber ascending.

    Available Fields for SalesShipmentLine:

    Property Type Length Notes
    CreatedBy String 50  
    CreatedOn DateTime    
    Guid Guid   Unique identifier. Can only be set when adding a record.
    LastModifiedBy String 50  
    LastModifiedOn Nullable DateTime    
    SalesOrderLineNumber Integer    
    SalesOrderLineId Integer    
    LineNumber Integer   Line number maps to SalesOrderLineNumber
    Product Product    
    ShipmentQty Decimal    
    UnitCost Decimal    
    UnitCostAtTimeOfDispatch Decimal    
    SerialNumbers SerialNumber    
    BatchNumbers BatchNumber    
    CommercialMonetaryValue Nullable 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  

    Examples for Response GET /SalesShipments

    show xml example
    show json example

    POST / PUT SalesShipments

    These filters can be used with the POST / PUT SalesShipments endpoint:

    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 SalesShipments:

    Property Type Length Required Notes
    Guid Guid   Yes Unique identifier. Can only be set when adding a record.
    OrderNumber String 20 Yes  
    ShipmentStatus String 20 Yes  
    DispatchDate Nullable DateTime yyyy-mm-dd No  
    ShippingCompany Nullable ShippingCompany   No  
    TrackingNumber Nullable String 50 No  
    Comments Nullable String 500 No  
    SalesShipmentLines SalesShipmentLine   Yes At least one shipment line is required.

    Available Fields for ShippingCompany:

    Property Type Length Required Notes
    Guid Guid   Required when Name is not provided  
    Name String   Required when Guid is not provided  

    Available Fields for POST/PUT SalesShipmentLine:

    Property Type Length Required Notes
    Product Product   Yes  
    SerialNumbers SerialNumber     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.
    BatchNumbers BatchNumber     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.
    ShipmentQty Decimal   Yes  
    Guid Guid   No On Creation, the value will be ignored. On Update, If the Guid is set, it will try to update the existing lines instead of recreating them.
    SalesOrderLineNumber Integer   No 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.

    Available Fields for Product:

    Property Type Length Required Notes
    Guid Guid   No Unique identifier. Can only be set when adding a record.
    ProductCode String 100 Yes  

    Available fields for PUT SalesShipments:

    Property Type Length Required Notes
    Guid Guid   Yes Must be supplied for PUT to identify the Sales Shipment to update.
    ShipmentStatus String 20 Required when order management is enabled.  
    DispatchDate Nullable DateTime yyyy-mm-dd No  
    ShippingCompany Nullable ShippingCompany   No  
    TrackingNumber Nullable String 50 No  
    Comments Nullable String 500 No  
    SalesShipmentLines SalesShipmentLine   Yes  

    Available fields for ShippingCompany:

    Property Type Length Required Notes
    Guid Guid   Required when Name is not specified.  
    Name String   Required when Guid is not specified.  

    Examples for Request POST / PUT /SalesShipments

    show xml example
    show json example

    Examples for Response POST / PUT /SalesShipments

    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.