POST v3/load/{shipmentID}

Ship against a shipment

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shipmentID

integer

Required

Body Parameters

ShipModel
NameDescriptionTypeAdditional information
SKUID

Unique identifier of the SKU associated with the RTI being shipped

integer

None.

Quantity

The quantity of RTIs being shipped. Always 1 for serialized SKUs

decimal number

None.

Reference

Reference used in Ship Create Shipment method

string

None.

ToLocationID

Unique identifier of the destination location

integer

None.

OriginLocationZoneID

integer

None.

OriginPalletID

integer

None.

DeviceID

Unique identifier of the device that performed the Ship activity

integer

None.

Barcode

Barcode that is being shipped

string

None.

Barcodes

Collection of RTIModel

None.

SalesOrderID

integer

None.

TransactionID

Unique identifier of the transaction ID

integer

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

Response Information

Resource Description

MultiRTIResponseModel
NameDescriptionTypeAdditional information
Response

Actual Response from database. Can contain any model needed

Object

None.

Errors

List of errors from stored procedure

Collection of ErrorModel

None.

Response Formats

application/json, text/json

Sample:
{
  "response": {},
  "errors": [
    {
      "barcode": "sample string 1",
      "errorMessage": "sample string 2"
    },
    {
      "barcode": "sample string 1",
      "errorMessage": "sample string 2"
    }
  ]
}