A comprehensive list of the SKU list resource's attributes and relationships
A SKU list object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/sku_lists endpoint.
Last updated
| Field | Type | Description |
|---|
type |
|
|
id |
| The SKU list unique identifier |
links.self |
| The SKU list endpoint URL |
attributes.name |
| The SKU list's internal name. |
attributes.slug |
| The SKU list's internal slug. |
attributes.description |
| An internal description of the SKU list. |
attributes.image_url |
| The URL of an image that represents the SKU list. |
attributes.manual |
| Indicates if the SKU list is populated manually. |
attributes.sku_code_regex |
| The regex that will be evaluated to match the SKU codes. |
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.customer |
| The associated customer. |
relationships.skus |
| The associated SKUs. |
relationships.sku_list_items |
| The associated SKU list items. |
