2 augustus 2024
- Get list of integrationsGET
- Create integrationPOST
- Get integration by idGET
- Update integrationPUT
- Delete integrationDELETE
- Get integration actions by idGET
- Execute integration actionPOST
- Sync integration orders (async)POST
- Sync integration products (async)POST
- Get settings for integrationGET
- Sync integration shipping services (async)POST
- Sync integration product stocks (async)POST
- 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 request by id
GET
https://api.pack.cloud/v1/organizations/{organizationId}/return-requests/{returnRequestId}
Request
Path parameters
organizationIdstring
returnRequestIdstring
Response
OK
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
customs_shipment_typestringnull
Default shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
customs_use_reference_if_invoice_number_emptyboolean
Use order reference for customs invoice number
inbound_gb_eoristringnull
Inbound Economic Operators Registration and Identification number for GB
inbound_gb_vatstringnull
Inbound VAT identification number for GB
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
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
parent_idstringnull
ID of the parent order line (virtual bundle order line)
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
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
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
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 order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
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
Shipping cost paid by customer
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
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
shipping_preferences
idstring
ID of the return receipt
return_request_idstring
ID of the return request
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 shipping method
shipping_service_idstring
ID of the shipping service
namestring
Name of the shipping method
Example:PostNL Handtekening voor ontvangst
cancelableboolean
Shipping service accepts cancellation requests for shipments
enabledboolean
typestring
Type of shipping service
Allowed values:deliveryreturn
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
featuresobject
idstring
ID of the return refund
return_request_idstring
ID of the return request
codestringnull
Coupon / gift card code
Total value of refund
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Shipping cost to include
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
methodstring
Refund method
Allowed values:integrationmanual
remarksstring
Refund remarks
statusstring
Refund status
Allowed values:createdrequestedpendingcompletederror
typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return refund line
return_request_line_idstring
ID of the return request line
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
quantityinteger
Quantity that is solved
idstring
ID of the address
company_namestringnull
Company name
Example:Large Company Ltd
namestringnull
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2stringnull
Second address line
Example:Second line
house_numberstringnull
House number and addition
Example:123A bus 2
postal_codestringnull
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestringnull
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstringnull
Email address
phonestringnull
Phone number
phone_e164stringnull
Phone number in E.164 format
eoristringnull
Economic Operators Registration and Identification number
ossstringnull
One-Stop Shop (OSS) number
vatstringnull
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
OK
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
customs_shipment_typestringnull
Default shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
customs_use_reference_if_invoice_number_emptyboolean
Use order reference for customs invoice number
inbound_gb_eoristringnull
Inbound Economic Operators Registration and Identification number for GB
inbound_gb_vatstringnull
Inbound VAT identification number for GB
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
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
parent_idstringnull
ID of the parent order line (virtual bundle order line)
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
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
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
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 order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
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
Shipping cost paid by customer
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
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
shipping_preferences
idstring
ID of the return receipt
return_request_idstring
ID of the return request
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 shipping method
shipping_service_idstring
ID of the shipping service
namestring
Name of the shipping method
Example:PostNL Handtekening voor ontvangst
cancelableboolean
Shipping service accepts cancellation requests for shipments
enabledboolean
typestring
Type of shipping service
Allowed values:deliveryreturn
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
featuresobject
idstring
ID of the return refund
return_request_idstring
ID of the return request
codestringnull
Coupon / gift card code
Total value of refund
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Shipping cost to include
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
methodstring
Refund method
Allowed values:integrationmanual
remarksstring
Refund remarks
statusstring
Refund status
Allowed values:createdrequestedpendingcompletederror
typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return refund line
return_request_line_idstring
ID of the return request line
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
quantityinteger
Quantity that is solved
idstring
ID of the address
company_namestringnull
Company name
Example:Large Company Ltd
namestringnull
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2stringnull
Second address line
Example:Second line
house_numberstringnull
House number and addition
Example:123A bus 2
postal_codestringnull
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestringnull
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstringnull
Email address
phonestringnull
Phone number
phone_e164stringnull
Phone number in E.164 format
eoristringnull
Economic Operators Registration and Identification number
ossstringnull
One-Stop Shop (OSS) number
vatstringnull
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
OK
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
customs_shipment_typestringnull
Default shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
customs_use_reference_if_invoice_number_emptyboolean
Use order reference for customs invoice number
inbound_gb_eoristringnull
Inbound Economic Operators Registration and Identification number for GB
inbound_gb_vatstringnull
Inbound VAT identification number for GB
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
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
parent_idstringnull
ID of the parent order line (virtual bundle order line)
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
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
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
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 order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
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
Shipping cost paid by customer
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
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
shipping_preferences
idstring
ID of the return receipt
return_request_idstring
ID of the return request
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 shipping method
shipping_service_idstring
ID of the shipping service
namestring
Name of the shipping method
Example:PostNL Handtekening voor ontvangst
cancelableboolean
Shipping service accepts cancellation requests for shipments
enabledboolean
typestring
Type of shipping service
Allowed values:deliveryreturn
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
featuresobject
idstring
ID of the return refund
return_request_idstring
ID of the return request
codestringnull
Coupon / gift card code
Total value of refund
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Shipping cost to include
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
methodstring
Refund method
Allowed values:integrationmanual
remarksstring
Refund remarks
statusstring
Refund status
Allowed values:createdrequestedpendingcompletederror
typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return refund line
return_request_line_idstring
ID of the return request line
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
quantityinteger
Quantity that is solved
idstring
ID of the address
company_namestringnull
Company name
Example:Large Company Ltd
namestringnull
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2stringnull
Second address line
Example:Second line
house_numberstringnull
House number and addition
Example:123A bus 2
postal_codestringnull
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestringnull
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstringnull
Email address
phonestringnull
Phone number
phone_e164stringnull
Phone number in E.164 format
eoristringnull
Economic Operators Registration and Identification number
ossstringnull
One-Stop Shop (OSS) number
vatstringnull
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
OK
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
customs_shipment_typestringnull
Default shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
customs_use_reference_if_invoice_number_emptyboolean
Use order reference for customs invoice number
inbound_gb_eoristringnull
Inbound Economic Operators Registration and Identification number for GB
inbound_gb_vatstringnull
Inbound VAT identification number for GB
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
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
parent_idstringnull
ID of the parent order line (virtual bundle order line)
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
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
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
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 order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
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
Shipping cost paid by customer
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
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
shipping_preferences
idstring
ID of the return receipt
return_request_idstring
ID of the return request
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 shipping method
shipping_service_idstring
ID of the shipping service
namestring
Name of the shipping method
Example:PostNL Handtekening voor ontvangst
cancelableboolean
Shipping service accepts cancellation requests for shipments
enabledboolean
typestring
Type of shipping service
Allowed values:deliveryreturn
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
featuresobject
idstring
ID of the return refund
return_request_idstring
ID of the return request
codestringnull
Coupon / gift card code
Total value of refund
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Shipping cost to include
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
methodstring
Refund method
Allowed values:integrationmanual
remarksstring
Refund remarks
statusstring
Refund status
Allowed values:createdrequestedpendingcompletederror
typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return refund line
return_request_line_idstring
ID of the return request line
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
quantityinteger
Quantity that is solved
idstring
ID of the address
company_namestringnull
Company name
Example:Large Company Ltd
namestringnull
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2stringnull
Second address line
Example:Second line
house_numberstringnull
House number and addition
Example:123A bus 2
postal_codestringnull
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestringnull
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstringnull
Email address
phonestringnull
Phone number
phone_e164stringnull
Phone number in E.164 format
eoristringnull
Economic Operators Registration and Identification number
ossstringnull
One-Stop Shop (OSS) number
vatstringnull
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
OK
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the brand
namestring
Name of the brand
Example:My Online Store Name
customs_shipment_typestringnull
Default shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
customs_use_reference_if_invoice_number_emptyboolean
Use order reference for customs invoice number
inbound_gb_eoristringnull
Inbound Economic Operators Registration and Identification number for GB
inbound_gb_vatstringnull
Inbound VAT identification number for GB
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
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
parent_idstringnull
ID of the parent order line (virtual bundle order line)
order_idstring
ID of the order
product_idstring
ID of the ordered product
namestring
Name of the product ordered
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
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
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
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 order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
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
Shipping cost paid by customer
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
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
shipping_preferences
idstring
ID of the return receipt
return_request_idstring
ID of the return request
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 shipping method
shipping_service_idstring
ID of the shipping service
namestring
Name of the shipping method
Example:PostNL Handtekening voor ontvangst
cancelableboolean
Shipping service accepts cancellation requests for shipments
enabledboolean
typestring
Type of shipping service
Allowed values:deliveryreturn
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
featuresobject
idstring
ID of the return refund
return_request_idstring
ID of the return request
codestringnull
Coupon / gift card code
Total value of refund
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Shipping cost to include
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
methodstring
Refund method
Allowed values:integrationmanual
remarksstring
Refund remarks
statusstring
Refund status
Allowed values:createdrequestedpendingcompletederror
typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the return refund line
return_request_line_idstring
ID of the return request line
Price per item
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
quantityinteger
Quantity that is solved
idstring
ID of the address
company_namestringnull
Company name
Example:Large Company Ltd
namestringnull
Contact person name
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2stringnull
Second address line
Example:Second line
house_numberstringnull
House number and addition
Example:123A bus 2
postal_codestringnull
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestringnull
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstringnull
Email address
phonestringnull
Phone number
phone_e164stringnull
Phone number in E.164 format
eoristringnull
Economic Operators Registration and Identification number
ossstringnull
One-Stop Shop (OSS) number
vatstringnull
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
