31 mei 2024
Get shipping methods
GET
https://api.pack.cloud/v1/organizations/{organizationId}/shipping-service-methods
Request
Path parameters
organizationIdstring
Query parameters
filter[countries.enabled]boolean
This filter will check if there is an enabled country for this method
filter[countries.from_country_code]string
This filter will only return shipping methods that has the possibility to send from this country code
filter[countries.to_country_code]string
This filter will only return shipping methods that has the possibility to send to this country code
filter[enabled]boolean
filter[shipping_service_id]string
filter[type]string
includearray
Allowed values:shipping_serviceshipping_service.carrier
Response
OK
Body
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
