The SaleShip resource allows to create new shipment or replace existing Shipment in sale task. This is how you call it:

The full range of URIs and HTTP Verbs supported are:

Operation

HTTP Action

Create or add new Shipment

POST /SaleShip

Replace existing non-authorised Shipment lines with new and authorise it

PUT /SaleShip

 

 

Available Fields for SaleShip:



Property

Type

Length

Required

Notes

TaskID

Guid

Yes

Sale task identifier

Lines

Array of ShipLine

1

Yes

At least one line required. See below.

 

Available Fields for ShipLine:

Property

Type

Length

Required

Notes

Carrier

String

256

Yes

Carrier name doing shipment

ShipmentDate

Date

 

 

Date when box was shipped. Default value is current date

Box

String

256

Yes

box number/name to be included in the shipment

TrackingNumber

String

256

Tracking number for the shipment

 

 

Operation description

To create new or add lines to existing Shipment you need to send POST request to SaleShip endpoint with SaleShip structure (see above) as payload.

To replace existing Shipment with new, you need to use PUT request, but to use it you need to have non-authorised Shipment. Also your payload should contain all boxes from Packing stage listed in Lines.

Please note, that it is impossible to use this endpoint if sale task contain product from external location (using external fulfilment service).

Sample of payload

POST /SaleShip

{

 "TaskID": "E6E8163F-6911-40e9-B740-90E5A0A3A996",

 "Lines": [{

 "Carrier": "UPS",

 "ShipmentDate": "2015/01/01",

 "TrackingNumber": "ABCDEF123",

 "Box": "Box 1"

 },

 {

 "Carrier": "DHL",

 "ShipmentDate": "2015/01/01",

 "TrackingNumber": "1113332",

 "Box": "Box 2"

 }

 ]

}

 

 

PUT /SaleShip

{

 "TaskID": "E6E8163F-6911-40e9-B740-90E5A0A3A996",

 "Lines": [{

 "Carrier": "UPS",

 "ShipmentDate": "2015/01/01",

 "TrackingNumber": "ABCDEF123",

 "Box": "Box 1"

 },

 {

 "Carrier": "DHL",

 "ShipmentDate": "2015/01/01",

 "TrackingNumber": "1113332",

 "Box": "Box 2"

 }

 ]

}

 

Note

Status of shipment for Sale task will be automatically changed to “AUTHORISED” after all packed boxes from packing would be shipped.

 

Return value

In case if no errors occurred you will receive response with list of shipments for specified Sale Task, otherwise you will receive response with error list, like this:

[{

ErrorCode”:400,

“Exception”:”Error explanation will be here”

},

{

ErrorCode”:400,

“Exception”:”Error explanation will be here”

}]