Shipping categories determine which shipping methods are available for the associated SKUs. An order is split into more shipments if it contains line items belonging to more than one shipping category.
A shipping category object is returned as part of the response body of each successful list, retrieve, create or update API call.
Field | Type | Description |
type |
|
|
id |
| The shipping category unique identifier |
links.self |
| The shipping category endpoint URL |
attributes.name |
| The shipping category name. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
relationships.skus |
| The associated skus. |
relationships.attachments |
| The associated attachments. |
meta.mode |
| The resource environment (can be one of |