The shipping category object

A comprehensive list of the shipping category resource's attributes and relationships

A shipping category object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/shipping_categories endpoint.

Fields

FieldTypeDescription

type

string

shipping_categories

id

string

The shipping category unique identifier

links.self

string

The shipping category endpoint URL

attributes.name

string

The shipping category name.

attributes.code

string

A string that you can use to identify the shipping category (must be unique within the environment).

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

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

string

Any identifier of the third party system that defines the reference code

attributes.metadata

object

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

array

The associated SKUs.

relationships.attachments

array

The associated attachments.

relationships.versions

array

The associated changes.

meta.mode

string

The resource environment (can be one of test or live)

Last updated