Create scheduling groups

Bulk-creates scheduling groups. Successful entities are returned in data; per-item failures in errors.

POST/api/v2/{team_slug}/{app_slug}/schedule/groups

Authorization

AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters

team_slugstringrequired

app_slugstringrequired

Request body

requiredapplication/json

groupsCreateScheduleGroupItem[]required

min items 1 · max items 20

Show properties

Array of CreateScheduleGroupItem

namestringrequired

jobsCreateScheduleJobItem[]

Show properties

Array of CreateScheduleJobItem

item_idUUIDrequired

item_typestringrequired

execute_atstring<date-time>required

to_statusstring

add_tag_idsUUID[]

remove_tag_idsUUID[]

add_category_idsUUID[]

remove_category_idsUUID[]

add_collection_idsUUID[]

remove_collection_idsUUID[]

to_amount_cents_with_taxinteger

to_sale_amount_cents_with_taxinteger

to_on_saleboolean

to_market_idUUID | null

Show properties

Any of:

UUID

string<uuid>

null

null

to_store_group_idUUID | null

Show properties

Any of:

UUID

UUID

null

null

to_market_statusstring

to_start_sale_timestampstring<date-time>

to_stop_sale_timestampstring<date-time>

group_idUUID | null

Show properties

Any of:

UUID

UUID

null

null

Responses

201

Created (partial success possible)

dataScheduleGroup[]required

Show properties

Array of ScheduleGroup

idUUIDrequired

namestringrequired

created_atstring<date-time>required

jobsScheduleJob[] | null

Show properties

Array of ScheduleJob

idUUIDrequired

item_idUUIDrequired

item_typestringrequired

item_namestring | null

execute_atstring<date-time>required

finished_atstring<date-time> | null

to_statusstring | null

add_tag_idsUUID[]

remove_tag_idsUUID[]

add_category_idsUUID[]

remove_category_idsUUID[]

add_collection_idsUUID[]

remove_collection_idsUUID[]

to_amount_cents_with_taxinteger | null

to_sale_amount_cents_with_taxinteger | null

to_on_saleboolean | null

to_market_idUUID | null

Show properties

Any of:

UUID

UUID

null

null

to_store_group_idUUID | null

Show properties

Any of:

UUID

UUID

null

null

to_market_statusstring | null

to_start_sale_timestampstring<date-time> | null

to_stop_sale_timestampstring<date-time> | null

group_idUUID | null

Show properties

Any of:

UUID

UUID

null

null

created_atstring<date-time>required

updated_atstring<date-time> | null

errorsScheduleGroupError[]required

Show properties

Array of ScheduleGroupError

namestring

idUUID | null

Show properties

Any of:

UUID

string<uuid>

null

null

messagestringrequired

400

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

401

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

403

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

500

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

team_slugpath*app_slugpath*

Bodyapplication/json

Request body

{
  "groups": [
    {
      "name": "string",
      "jobs": [
        {
          "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
          "item_type": "string",
          "execute_at": "2019-08-24T14:15:22Z",
          "to_status": "string",
          "add_tag_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "remove_tag_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "add_category_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "remove_category_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "add_collection_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "remove_collection_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "to_amount_cents_with_tax": 0,
          "to_sale_amount_cents_with_tax": 0,
          "to_on_sale": true,
          "to_market_id": "0934fc5b-84c6-4c9a-8661-3385966d0768",
          "to_store_group_id": "486fb14a-80df-44a1-ad6f-386496b52f2f",
          "to_market_status": "string",
          "to_start_sale_timestamp": "2019-08-24T14:15:22Z",
          "to_stop_sale_timestamp": "2019-08-24T14:15:22Z",
          "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f"
        }
      ]
    }
  ]
}

Request

curl -X POST 'https://api.enad.io/api/v2/string/string/schedule/groups' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "groups": [
    {
      "name": "string",
      "jobs": [
        {
          "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
          "item_type": "string",
          "execute_at": "2019-08-24T14:15:22Z",
          "to_status": "string",
          "add_tag_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "remove_tag_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "add_category_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "remove_category_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "add_collection_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "remove_collection_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "to_amount_cents_with_tax": 0,
          "to_sale_amount_cents_with_tax": 0,
          "to_on_sale": true,
          "to_market_id": "0934fc5b-84c6-4c9a-8661-3385966d0768",
          "to_store_group_id": "486fb14a-80df-44a1-ad6f-386496b52f2f",
          "to_market_status": "string",
          "to_start_sale_timestamp": "2019-08-24T14:15:22Z",
          "to_stop_sale_timestamp": "2019-08-24T14:15:22Z",
          "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f"
        }
      ]
    }
  ]
}'

const response = await fetch("https://api.enad.io/api/v2/string/string/schedule/groups", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"groups\": [\n    {\n      \"name\": \"string\",\n      \"jobs\": [\n        {\n          \"item_id\": \"4d8cd62e-a579-4dae-af8c-3172f96f8f7c\",\n          \"item_type\": \"string\",\n          \"execute_at\": \"2019-08-24T14:15:22Z\",\n          \"to_status\": \"string\",\n          \"add_tag_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"remove_tag_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"add_category_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"remove_category_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"add_collection_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"remove_collection_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"to_amount_cents_with_tax\": 0,\n          \"to_sale_amount_cents_with_tax\": 0,\n          \"to_on_sale\": true,\n          \"to_market_id\": \"0934fc5b-84c6-4c9a-8661-3385966d0768\",\n          \"to_store_group_id\": \"486fb14a-80df-44a1-ad6f-386496b52f2f\",\n          \"to_market_status\": \"string\",\n          \"to_start_sale_timestamp\": \"2019-08-24T14:15:22Z\",\n          \"to_stop_sale_timestamp\": \"2019-08-24T14:15:22Z\",\n          \"group_id\": \"306db4e0-7449-4501-b76f-075576fe2d8f\"\n        }\n      ]\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.enad.io/api/v2/string/string/schedule/groups",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"groups\": [\n    {\n      \"name\": \"string\",\n      \"jobs\": [\n        {\n          \"item_id\": \"4d8cd62e-a579-4dae-af8c-3172f96f8f7c\",\n          \"item_type\": \"string\",\n          \"execute_at\": \"2019-08-24T14:15:22Z\",\n          \"to_status\": \"string\",\n          \"add_tag_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"remove_tag_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"add_category_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"remove_category_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"add_collection_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"remove_collection_ids\": [\n            \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n          ],\n          \"to_amount_cents_with_tax\": 0,\n          \"to_sale_amount_cents_with_tax\": 0,\n          \"to_on_sale\": true,\n          \"to_market_id\": \"0934fc5b-84c6-4c9a-8661-3385966d0768\",\n          \"to_store_group_id\": \"486fb14a-80df-44a1-ad6f-386496b52f2f\",\n          \"to_market_status\": \"string\",\n          \"to_start_sale_timestamp\": \"2019-08-24T14:15:22Z\",\n          \"to_stop_sale_timestamp\": \"2019-08-24T14:15:22Z\",\n          \"group_id\": \"306db4e0-7449-4501-b76f-075576fe2d8f\"\n        }\n      ]\n    }\n  ]\n}",
)

Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "jobs": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
          "item_type": "string",
          "item_name": "string",
          "execute_at": "2019-08-24T14:15:22Z",
          "finished_at": "2019-08-24T14:15:22Z",
          "to_status": "string",
          "add_tag_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "remove_tag_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "add_category_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "remove_category_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "add_collection_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "remove_collection_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "to_amount_cents_with_tax": 0,
          "to_sale_amount_cents_with_tax": 0,
          "to_on_sale": true,
          "to_market_id": "0934fc5b-84c6-4c9a-8661-3385966d0768",
          "to_store_group_id": "486fb14a-80df-44a1-ad6f-386496b52f2f",
          "to_market_status": "string",
          "to_start_sale_timestamp": "2019-08-24T14:15:22Z",
          "to_stop_sale_timestamp": "2019-08-24T14:15:22Z",
          "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "errors": [
    {
      "name": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "message": "string"
    }
  ]
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}