Update a SKU

How to update an existing SKU via API

To update an existing SKU, send a PATCH request to the /api/skus/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/skus/:id

Arguments

Body Parameter
Type
Required

type

string

Required

id

string

Required

attributes.code

string

Optional

attributes.name

string

Optional

attributes.description

string

Optional

attributes.image_url

string

Optional

attributes.pieces_per_pack

integer

Optional

attributes.weight

float

Optional

attributes.unit_of_weight

string

Optional

attributes.hs_tariff_number

string

Optional

attributes.do_not_ship

boolean

Optional

attributes.do_not_track

boolean

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.shipping_category

object

Optional

relationships.tags

array

Optional

Example

The following request updates the SKU identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/skus/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "skus",
    "id": "xYZkjABcde",
    "attributes": {
      "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
    },
    "relationships": {
      "shipping_category": {
        "data": {
          "type": "shipping_categories",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Last updated