The Rest API is deprecated and will be removed in the future. We recommend using the GraphQL API instead. Some endpoints may not be available anymore.
- 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 return receipt by id
GET
https://api.pack.cloud/v1/warehouses/{warehouseId}/return-receipts/{returnReceiptId}
Request
Path parameters
warehouseIdstring
returnReceiptIdstring
Response
OK
Body
idstring
ID of the return receipt
return_request_idstring
ID of the return request
organization_idstring
ID of the organization
remarksstringnull
Remarks of the return receipt
statusstring
Status of the return receipt
Allowed values:createdpendingcompleted
completed_atstringnull
Receipt marked completed at
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return receipt line
return_request_line_idstring
ID of the return request line
quantity_receivedinteger
Quantity that is received back
conditionstring
Condition of the received items
Allowed values:saleableunsalable
remarksstring
Remarks of the received items
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return request
organization_idstring
ID of the organization
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
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 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 return line
order_line_idstring
ID of the order line
product_idstring
ID of the product
return_reason_idstring
ID of the return reason
sub_return_reason_idstring
ID of the return reason
quantity_expectedinteger
Quantity that is expected
quantity_receivedinteger
Quantity that is received
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the order line
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
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
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 return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd
OK
Body
idstring
ID of the return receipt
return_request_idstring
ID of the return request
organization_idstring
ID of the organization
remarksstringnull
Remarks of the return receipt
statusstring
Status of the return receipt
Allowed values:createdpendingcompleted
completed_atstringnull
Receipt marked completed at
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return receipt line
return_request_line_idstring
ID of the return request line
quantity_receivedinteger
Quantity that is received back
conditionstring
Condition of the received items
Allowed values:saleableunsalable
remarksstring
Remarks of the received items
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return request
organization_idstring
ID of the organization
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
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 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 return line
order_line_idstring
ID of the order line
product_idstring
ID of the product
return_reason_idstring
ID of the return reason
sub_return_reason_idstring
ID of the return reason
quantity_expectedinteger
Quantity that is expected
quantity_receivedinteger
Quantity that is received
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the order line
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
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
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 return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd
OK
Body
idstring
ID of the return receipt
return_request_idstring
ID of the return request
organization_idstring
ID of the organization
remarksstringnull
Remarks of the return receipt
statusstring
Status of the return receipt
Allowed values:createdpendingcompleted
completed_atstringnull
Receipt marked completed at
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return receipt line
return_request_line_idstring
ID of the return request line
quantity_receivedinteger
Quantity that is received back
conditionstring
Condition of the received items
Allowed values:saleableunsalable
remarksstring
Remarks of the received items
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return request
organization_idstring
ID of the organization
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
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 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 return line
order_line_idstring
ID of the order line
product_idstring
ID of the product
return_reason_idstring
ID of the return reason
sub_return_reason_idstring
ID of the return reason
quantity_expectedinteger
Quantity that is expected
quantity_receivedinteger
Quantity that is received
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the order line
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
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
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 return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd
OK
Body
idstring
ID of the return receipt
return_request_idstring
ID of the return request
organization_idstring
ID of the organization
remarksstringnull
Remarks of the return receipt
statusstring
Status of the return receipt
Allowed values:createdpendingcompleted
completed_atstringnull
Receipt marked completed at
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return receipt line
return_request_line_idstring
ID of the return request line
quantity_receivedinteger
Quantity that is received back
conditionstring
Condition of the received items
Allowed values:saleableunsalable
remarksstring
Remarks of the received items
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return request
organization_idstring
ID of the organization
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
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 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 return line
order_line_idstring
ID of the order line
product_idstring
ID of the product
return_reason_idstring
ID of the return reason
sub_return_reason_idstring
ID of the return reason
quantity_expectedinteger
Quantity that is expected
quantity_receivedinteger
Quantity that is received
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the order line
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
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
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 return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd
OK
Body
idstring
ID of the return receipt
return_request_idstring
ID of the return request
organization_idstring
ID of the organization
remarksstringnull
Remarks of the return receipt
statusstring
Status of the return receipt
Allowed values:createdpendingcompleted
completed_atstringnull
Receipt marked completed at
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return receipt line
return_request_line_idstring
ID of the return request line
quantity_receivedinteger
Quantity that is received back
conditionstring
Condition of the received items
Allowed values:saleableunsalable
remarksstring
Remarks of the received items
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return request
organization_idstring
ID of the organization
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
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 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 return line
order_line_idstring
ID of the order line
product_idstring
ID of the product
return_reason_idstring
ID of the return reason
sub_return_reason_idstring
ID of the return reason
quantity_expectedinteger
Quantity that is expected
quantity_receivedinteger
Quantity that is received
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the order line
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
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
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 return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the return reason
parent_idstring
ID of the parent return reason
created_atstring
Creation time of resource
codestring
Reference (code) of the return reason
namestring
Name of the return reason
updated_atstring
Latest update time of resource
idstring
ID of the organization
namestring
Organization name
Example:Demo Organization Ltd