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 shipment by id
GET
https://api.pack.cloud/v1/organizations/{organizationId}/shipments/{shipmentId}
Request
Path parameters
organizationIdstring
shipmentIdstring
Response
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
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
codestring
Code of the shipping status
Example:created
namestring
Human readable name of status
Example:Created
idstring
ID of the piece
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
Dimensions of piece
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Weight of piece
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
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
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
quantityinteger
Quantity
descriptionstringnull
Goods description for customs in English
Example:T-shirt
Price per unit
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
country_code_of_originstringnull
Country code of origin
Example:CN
hs_codeintegernull
Harmonized System code of product
Example:96091010
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
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
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
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
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
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
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
codestring
Code of the shipping status
Example:created
namestring
Human readable name of status
Example:Created
idstring
ID of the piece
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
Dimensions of piece
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Weight of piece
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
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
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
quantityinteger
Quantity
descriptionstringnull
Goods description for customs in English
Example:T-shirt
Price per unit
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
country_code_of_originstringnull
Country code of origin
Example:CN
hs_codeintegernull
Harmonized System code of product
Example:96091010
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
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
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
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
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
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
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
codestring
Code of the shipping status
Example:created
namestring
Human readable name of status
Example:Created
idstring
ID of the piece
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
Dimensions of piece
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Weight of piece
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
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
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
quantityinteger
Quantity
descriptionstringnull
Goods description for customs in English
Example:T-shirt
Price per unit
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
country_code_of_originstringnull
Country code of origin
Example:CN
hs_codeintegernull
Harmonized System code of product
Example:96091010
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
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
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
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
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
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
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
codestring
Code of the shipping status
Example:created
namestring
Human readable name of status
Example:Created
idstring
ID of the piece
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
Dimensions of piece
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Weight of piece
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
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
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
quantityinteger
Quantity
descriptionstringnull
Goods description for customs in English
Example:T-shirt
Price per unit
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
country_code_of_originstringnull
Country code of origin
Example:CN
hs_codeintegernull
Harmonized System code of product
Example:96091010
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
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
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
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
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
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
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
codestring
Code of the shipping status
Example:created
namestring
Human readable name of status
Example:Created
idstring
ID of the piece
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
Dimensions of piece
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Weight of piece
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
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
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
quantityinteger
Quantity
descriptionstringnull
Goods description for customs in English
Example:T-shirt
Price per unit
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
country_code_of_originstringnull
Country code of origin
Example:CN
hs_codeintegernull
Harmonized System code of product
Example:96091010
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
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
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
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
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
