Remove From Offers

POST

/preorders/products/remove_from_offers

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/preorders/products/remove_from_offers \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "shopify_variant_ids": [ "45000000001" ], "inventory_policy": "string" }'

• Production

Take variants out of every preorder offer they are in, as the store-wide Products tab’s ‘Remove from offer’ does.

Note: shopify_variant_ids are up to 100 Shopify variant gids. A variant in an offer that sells in selected markets only is skipped (skipped_market_shopify_variant_ids), as the tab skips it; ones STOQ has no row for come back under not_found. inventory_policy: DENY first turns ‘Continue selling’ off on the removed variants, offer by offer, as the tab’s Remove modal does by default; omit it to leave their policy. Finishes before the response. To remove from one offer only use /preorders/offers/:id/products/remove_variants.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

shopify_variant_ids

inventory_policy

Example

{
  "shopify_variant_ids": [
    "45000000001"
  ],
  "inventory_policy": "string"
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}