API Reference
joor.com

Create Collections

Create collections of products and SKUs.

👍

Endpoint

Params

  • Accept: application/json
  • Authorization: OAuth2 [Base64 encoded token]

Sample cURL Request

curl -X POST "https://api.jooraccess.com/v4/collections/bulk_create" -H  "accept: application/json" -H  "Content-Type: application/json" -d "[{\"name\":\"string\",\"external_id\":\"string\",\"season_id\":\"string\",\"delivery\":{\"start_ship_date\":\"string\",\"complete_ship_date\":\"string\",\"cancel_date\":\"string\",\"minimum_shipping_window\":0},\"items\":[{\"product_id\":\"string\",\"order_number\":0,\"sku_ids\":[\"string\"]}]}]"

Workflow

  1. Use this endpoint to create your collection level data
  2. Use the id from the CREATE /seasons or GET /seasons endpoint to map a season to your collection
  3. Use the GET /products and GET /skus endpoint. Insert the ids you want to make shoppable in the collection
    a. You can specify the SKUs that should be shoppable. If you only add the product id, all SKUs for that product will be shoppable
  4. If no dates are set, the delivery will be set to IMMEDIATE.
  5. You will need to reference the collection id when using the following endpoints:
  • UPDATE /collections

Collection Data

PARAMETERSREQUIREDTYPENOTES
nameYstring
external_idYstring
season_idNstring

Delivery Data

If you leave the start and end blank, this collection will be set as IMMEDIATE delivery.

PARAMETERSREQUIREDTYPENOTES
start_ship_dateNstring
complete_ship_dateNstring
cancel_dateNstring
minimum_shipping_windowNinteger

Collection Items Data

Insert a list of product ids to display in your collection. If you only want to display a specific list of SKUs, you can specify that in the sku_ids object.

PARAMETERSREQUIREDTYPENOTES
product_idNstringA list of product ids to include in this collection. Not required, but obviously recommended.
order_numberNintegerWhat order the product will be displayed in this collection.
sku_idsNstringA list of string ids to include for each product. If you only want to display specific SKUs for that product, you should pass that list of ids here.

Request Example

[
  {
    "name": "string",
    "external_id": "string",
    "season_id": "string",
    "delivery": {
      "start_ship_date": "string",
      "complete_ship_date": "string",
      "cancel_date": "string",
      "minimum_shipping_window": 0
    },
    "items": [
      {
        "product_id": "string",
        "order_number": 0,
        "sku_ids": [
          "string"
        ]
      }
    ]
  }
]

Response Example

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "external_id": "string",
      "delivery": {
        "start_ship_date": "string",
        "complete_ship_date": "string",
        "cancel_date": "string",
        "minimum_shipping_window": 0
      },
      "season": {
        "id": "string",
        "name": "string",
        "year": 0,
        "external_id": "string"
      },
      "visibility": "OWNER",
      "items": [
        {
          "product_id": "string",
          "order_number": 0,
          "sku_ids": [
            "string"
          ]
        }
      ]
    }
  ],
  "errors": []
}