v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB

Collections

Create Collection

Create a new collection.

post/collections

Request body

external_idstring nullable

The provided external_id must be unique. If a non-unique external_id is provided, the API will respond with an error.

sales_channelstring required

If a channel with this name is not already associated with the shop, it will be used to create a new channel.

namestring required

The name of the collection.

Example request

{
  "external_id": "71263csss-12uhsdfh-2138dja",
  "sales_channel": "shopify",
  "name": "Footwear"
}

Response

Success

Example response

{
  "collection": {
    "products": [
      {
        "id": 810772,
        "external_id": "564400c7-7a6b-4f29-b6a5-7bb580b2992c",
        "sku": "SHOES-US44-M-Brwn",
        "name": "Classic Brown Dress Shoes",
        "weight_grams": 440,
        "type": "shoes",
        "vendor": "Internal",
        "price": {
          "amount": 50000,
          "currency_code": "USD"
        },
        "created_at": "2023-04-25T13:25:00-05:00",
        "updated_at": "2023-04-25T13:45:00-05:00",
        "collections": [
          {
            "id": 891009,
            "external_id": "62291d16-9b61-4fbb-b868-21c2d32dc155"
          }
        ],
        "options": [
          {
            "position": 1,
            "values": [
              "red"
            ],
            "name": "Colors"
          }
        ],
        "images": [
          "https://example.com/example.jpg"
        ],
        "tags": [
          "shoes"
        ],
        "source": "Shopify",
        "default_variant_id": 810773
      }
    ]
  }
}