Update Collections

Update your collections.

👍

Endpoint

Params

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

Sample cURL Request

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

Workflow

  1. Fetch a list of collection ids using the GET /collections endpoint
  2. Reference the id for the collection you want to update

Collection Data

You will need to reference the Joor collection id that you want to update.

PARAMETERS

REQUIRED

TYPE

NOTES

id

Y

string

name

Y

string

season_id

N

string

Delivery Data

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

PARAMETERS

REQUIRED

TYPE

NOTES

start_ship_date

N

string

complete_ship_date

N

string

cancel_date

N

string

minimum_shipping_window

N

integer

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.

PARAMETERS

REQUIRED

TYPE

NOTES

product_id

N

string

A list of product ids to include in this collection. Not required, but obviously recommended.

sku_ids

N

string

A 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

[
  {
    "id": "string",
    "name": "string",
    "season_id": "string",
    "delivery": {
      "start_ship_date": "string",
      "complete_ship_date": "string",
      "cancel_date": "string",
      "minimum_shipping_window": 0
    },
    "items": [
      {
        "product_id": "string",
        "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": []
}