Get all variations

GET 
/pcm/variations

Get all variations

Request

Query Parameters

page[offset] int64

Possible values: <= 10000

The number of records to offset the results by.

page[limit] int64

Possible values: <= 10000

The number of records per page. The maximum limit is 100.

Responses

200

Returns all variations.

application/json

Schema

Schema

data object[]
Array [
id string
A unique identifier for a variation.
type string
Possible values: [product-variation]
This represents the type of resource object being returned. Always product-variation.
attributes object
name string
The name of a variation.
sort_order integer
The sort order value is visible when you add the variations and variation options to your catalogs. You can then use the sort_order value to program your storefront to display the variation options in the order that you want. The variation with the highest value of sort_order is displayed first. For example, a variation with a sort_order value of 3 appears before a variation with a sort_order value of 2. You can specify any numbers that you want. You can use 1, 2, 3, or 100, 90, 80, including, zero or negative numbers. You can set sort_order to either null or omit it entirely from the request if you wish to remove an existing sort_order attribute.
meta object
options object[]
Array [
id string
A unique ID that is generated when an option is created.
name string
A human recognizable identifier for the option, also used in the SLUG for child products. Option names can only contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed.
description string
A human recognizable description of the option.
created_at date-time
The date and time an option is created.
updated_at date-time
The date and time an option is updated.
sort_order integer
The sort order value is visible when you add the variations and variation options to your catalogs. You can then use the sort_order value to program your storefront to display the variation options in the order that you want. The variation with the highest value of sort_order is displayed first. For example, a variation with a sort_order value of 3 appears before a variation with a sort_order value of 2. You can specify any numbers that you want. You can use 1, 2, 3, or 100, 90, 80, including, zero or negative numbers. You can set sort_order to either null or omit it entirely from the request if you wish to remove an existing sort_order attribute.
]
owner string
Possible values: [organization, store]
The owner of the resource, either organization or store.
created_at date-time
The date and time a variation is created.
updated_at date-time
The date and time a variation is updated.
]
meta object

results object

Contains the results for the entire collection.

total integer

Total number of results for the entire collection.

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "type": "product-variation",
      "attributes": {
        "name": "string",
        "sort_order": 0
      },
      "meta": {
        "options": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "created_at": "2020-09-22T09:00:00",
            "updated_at": "2020-09-22T09:00:00",
            "sort_order": 0
          }
        ],
        "owner": "organization",
        "created_at": "2020-09-22T09:00:00",
        "updated_at": "2020-09-22T09:00:00"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 3
    }
  }
}

list-variations

{
  "data": [
    {
      "type": "product-variation",
      "id": "c1ccccba-53e4-46b5-aed8-94f32823148a",
      "attributes": {
        "name": "Size",
        "sort_order": 1
      },
      "meta": {
        "options": [
          {
            "id": "057a50ba-1afb-4944-9637-bd9b568a9f39",
            "name": "Large",
            "description": "Large size",
            "sort_order": 3,
            "created_at": "2024-01-25T11:25:38.001Z",
            "updated_at": "2024-01-25T11:25:38.001Z"
          },
          {
            "id": "fa191e68-9bba-49f9-8e12-056c4e8f50e2",
            "name": "Medium",
            "description": "Medium size",
            "sort_order": 2,
            "created_at": "2024-01-25T11:25:38.001Z",
            "updated_at": "2024-01-25T11:25:38.001Z"
          },
          {
            "id": "112d1c5c-d149-453e-b208-89470968bacf",
            "name": "Small",
            "description": "Small size",
            "sort_order": 1,
            "created_at": "2024-01-25T11:25:38.001Z",
            "updated_at": "2024-01-25T11:25:38.001Z"
          }
        ],
        "owner": "store",
        "created_at": "2024-01-25T11:25:38.001Z",
        "updated_at": "2024-01-25T11:25:38.001Z"
      }
    },
    {
      "type": "product-variation",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "attributes": {
        "name": "Paint Color"
      },
      "meta": {
        "owner": "store",
        "created_at": "2024-01-25T11:25:38.001Z",
        "updated_at": "2024-01-25T11:25:38.001Z"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 2
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

bad-request

{
  "errors": [
    {
      "title": "Bad Request",
      "detail": "Could not parse the supplied filter",
      "status": "400"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": "500",
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Loading...