2 augustus 2024
- Get goods receipt piecesGET
- Create goods receipt piecePOST
- Get goods receipt piece by idGET
- Update goods receipt piecePUT
- Get goods receiptsGET
- Create goods receiptPOST
- Get goods receipt by idGET
- Get goods receipt linesGET
- Create goods receipt linePOST
- Get goods receipt line by idGET
- Get goods receipt purchase ordersGET
- Get list of picklistsGET
- Create picklistPOST
- Get count of picklistsGET
- Get preview draft picklistGET
- Get picklist by idGET
- Update picklistPUT
- Mutate (partial) picked allocationsPOST
- Get list of fulfillments in picklistGET
- Bulk Update fulfillment picklistsPUT
- Link fulfillment to picklistPOST
- Update fulfillmentPUT
- Unlink fulfillment from picklistDELETE
- Get list of rule typesGET
- Get rule typeGET
- Get list of rulesGET
- Create rulePOST
- Get rule by idGET
- Update rulePUT
- Delete ruleDELETE
- Get rule actionsGET
- Create rule actionPOST
- Get rule action by idGET
- Update rule actionPUT
- Delete rule actionDELETE
- Get rule conditionsGET
- Create rule conditionPOST
- Get rule condition by idGET
- Update rule conditionPUT
- Delete rule conditionDELETE
Get fulfillment by id
GET
https://api.pack.cloud/v1/warehouses/{warehouseId}/fulfillments/{fulfillmentId}
Request
Path parameters
warehouseIdstring
fulfillmentIdstring
Response
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the event
codestringnull
categorystring
Category of event
Allowed values:errorinfotracking
messagestring
Message of event
Creator of event
namestring
Name of the event creator
Image of event creator
urlstring
URL of the avatar
created_atstring
Creation time of event
occurred_atstring
Occurrance time of event
updated_atstring
Latest update time of event
advicestringnull
Advice to resolve the exception
datastring
Technical data of exception
messagestring
Human readable message
typestring
Type of exception
Allowed values:customs_missing_order_datafulfillment_shipment_creation_failedintegration_shipped_quantityno_shipping_service_methodorder_holdorder_line_missing_productrecipient_address_incorrectrecipient_address_details_incorrect
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the allocation
fulfillment_line_idstring
ID of the linked fulfillment line
original_stock_idstringnull
ID of the stock before picked
stock_idstringnull
ID of the stock
quantityinteger
quantity_allocatedinteger
Stock quantity that is allocated
quantity_exceptioninteger
Quantity that is in exception
quantity_pickedinteger
Quantity that is picked
quantity_shippedinteger
Quantity that is shipped
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
One of
idstring
ID of the bin
bin_type_idstring
ID of the bin type
trolley_idstringnull
ID of the trolley
trolley_positionintegernull
Position of the bin in trolley
namestring
Name
Example:WB0000001
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product
organization_idstring
ID of the organization
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the order
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
canceled_atstring
Cancellation time, if canceled
shipped_atstring
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd
idstring
ID of the order
assigned_to_user_idstringnull
ID of the assigned user
trolley_idstringnull
ID of the trolley used for picking
referencestring
Human readable generated reference
Example:P220101-001
statusstring
Status of the picklist
Allowed values:createdpickingpickedcompleted
typestring
Type of the picklist
Allowed values:multisingle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the event
codestringnull
categorystring
Category of event
Allowed values:errorinfotracking
messagestring
Message of event
Creator of event
namestring
Name of the event creator
Image of event creator
urlstring
URL of the avatar
created_atstring
Creation time of event
occurred_atstring
Occurrance time of event
updated_atstring
Latest update time of event
advicestringnull
Advice to resolve the exception
datastring
Technical data of exception
messagestring
Human readable message
typestring
Type of exception
Allowed values:customs_missing_order_datafulfillment_shipment_creation_failedintegration_shipped_quantityno_shipping_service_methodorder_holdorder_line_missing_productrecipient_address_incorrectrecipient_address_details_incorrect
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the allocation
fulfillment_line_idstring
ID of the linked fulfillment line
original_stock_idstringnull
ID of the stock before picked
stock_idstringnull
ID of the stock
quantityinteger
quantity_allocatedinteger
Stock quantity that is allocated
quantity_exceptioninteger
Quantity that is in exception
quantity_pickedinteger
Quantity that is picked
quantity_shippedinteger
Quantity that is shipped
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
One of
idstring
ID of the bin
bin_type_idstring
ID of the bin type
trolley_idstringnull
ID of the trolley
trolley_positionintegernull
Position of the bin in trolley
namestring
Name
Example:WB0000001
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product
organization_idstring
ID of the organization
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the order
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
canceled_atstring
Cancellation time, if canceled
shipped_atstring
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd
idstring
ID of the order
assigned_to_user_idstringnull
ID of the assigned user
trolley_idstringnull
ID of the trolley used for picking
referencestring
Human readable generated reference
Example:P220101-001
statusstring
Status of the picklist
Allowed values:createdpickingpickedcompleted
typestring
Type of the picklist
Allowed values:multisingle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the event
codestringnull
categorystring
Category of event
Allowed values:errorinfotracking
messagestring
Message of event
Creator of event
namestring
Name of the event creator
Image of event creator
urlstring
URL of the avatar
created_atstring
Creation time of event
occurred_atstring
Occurrance time of event
updated_atstring
Latest update time of event
advicestringnull
Advice to resolve the exception
datastring
Technical data of exception
messagestring
Human readable message
typestring
Type of exception
Allowed values:customs_missing_order_datafulfillment_shipment_creation_failedintegration_shipped_quantityno_shipping_service_methodorder_holdorder_line_missing_productrecipient_address_incorrectrecipient_address_details_incorrect
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the allocation
fulfillment_line_idstring
ID of the linked fulfillment line
original_stock_idstringnull
ID of the stock before picked
stock_idstringnull
ID of the stock
quantityinteger
quantity_allocatedinteger
Stock quantity that is allocated
quantity_exceptioninteger
Quantity that is in exception
quantity_pickedinteger
Quantity that is picked
quantity_shippedinteger
Quantity that is shipped
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
One of
idstring
ID of the bin
bin_type_idstring
ID of the bin type
trolley_idstringnull
ID of the trolley
trolley_positionintegernull
Position of the bin in trolley
namestring
Name
Example:WB0000001
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product
organization_idstring
ID of the organization
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the order
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
canceled_atstring
Cancellation time, if canceled
shipped_atstring
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd
idstring
ID of the order
assigned_to_user_idstringnull
ID of the assigned user
trolley_idstringnull
ID of the trolley used for picking
referencestring
Human readable generated reference
Example:P220101-001
statusstring
Status of the picklist
Allowed values:createdpickingpickedcompleted
typestring
Type of the picklist
Allowed values:multisingle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the event
codestringnull
categorystring
Category of event
Allowed values:errorinfotracking
messagestring
Message of event
Creator of event
namestring
Name of the event creator
Image of event creator
urlstring
URL of the avatar
created_atstring
Creation time of event
occurred_atstring
Occurrance time of event
updated_atstring
Latest update time of event
advicestringnull
Advice to resolve the exception
datastring
Technical data of exception
messagestring
Human readable message
typestring
Type of exception
Allowed values:customs_missing_order_datafulfillment_shipment_creation_failedintegration_shipped_quantityno_shipping_service_methodorder_holdorder_line_missing_productrecipient_address_incorrectrecipient_address_details_incorrect
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the allocation
fulfillment_line_idstring
ID of the linked fulfillment line
original_stock_idstringnull
ID of the stock before picked
stock_idstringnull
ID of the stock
quantityinteger
quantity_allocatedinteger
Stock quantity that is allocated
quantity_exceptioninteger
Quantity that is in exception
quantity_pickedinteger
Quantity that is picked
quantity_shippedinteger
Quantity that is shipped
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
One of
idstring
ID of the bin
bin_type_idstring
ID of the bin type
trolley_idstringnull
ID of the trolley
trolley_positionintegernull
Position of the bin in trolley
namestring
Name
Example:WB0000001
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product
organization_idstring
ID of the organization
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the order
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
canceled_atstring
Cancellation time, if canceled
shipped_atstring
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd
idstring
ID of the order
assigned_to_user_idstringnull
ID of the assigned user
trolley_idstringnull
ID of the trolley used for picking
referencestring
Human readable generated reference
Example:P220101-001
statusstring
Status of the picklist
Allowed values:createdpickingpickedcompleted
typestring
Type of the picklist
Allowed values:multisingle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the event
codestringnull
categorystring
Category of event
Allowed values:errorinfotracking
messagestring
Message of event
Creator of event
namestring
Name of the event creator
Image of event creator
urlstring
URL of the avatar
created_atstring
Creation time of event
occurred_atstring
Occurrance time of event
updated_atstring
Latest update time of event
advicestringnull
Advice to resolve the exception
datastring
Technical data of exception
messagestring
Human readable message
typestring
Type of exception
Allowed values:customs_missing_order_datafulfillment_shipment_creation_failedintegration_shipped_quantityno_shipping_service_methodorder_holdorder_line_missing_productrecipient_address_incorrectrecipient_address_details_incorrect
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the allocation
fulfillment_line_idstring
ID of the linked fulfillment line
original_stock_idstringnull
ID of the stock before picked
stock_idstringnull
ID of the stock
quantityinteger
quantity_allocatedinteger
Stock quantity that is allocated
quantity_exceptioninteger
Quantity that is in exception
quantity_pickedinteger
Quantity that is picked
quantity_shippedinteger
Quantity that is shipped
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
One of
idstring
ID of the bin
bin_type_idstring
ID of the bin type
trolley_idstringnull
ID of the trolley
trolley_positionintegernull
Position of the bin in trolley
namestring
Name
Example:WB0000001
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product
organization_idstring
ID of the organization
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the order
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
canceled_atstring
Cancellation time, if canceled
shipped_atstring
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the address
company_namestring
Company name
Example:Large Company Ltd
namestring
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2string
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
phone_e164string
Phone number in E.164 format
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
typestring
Address type
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
formatted_linesstring
Formatted address lines for address
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd
idstring
ID of the order
assigned_to_user_idstringnull
ID of the assigned user
trolley_idstringnull
ID of the trolley used for picking
referencestring
Human readable generated reference
Example:P220101-001
statusstring
Status of the picklist
Allowed values:createdpickingpickedcompleted
typestring
Type of the picklist
Allowed values:multisingle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
