Update Offer

POST

vendor

offers

{id}

curl -X POST 'http://localhost:9000/vendor/offers/offer_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"prices": [{ "id": "price_01HXYZ", "amount": 2300, "currency_code": "usd" }]}'

const { offer } = await client.vendor.offers.$id.mutate({
  $id: "offer_01HXYZ",
  prices: [{ id: "price_01HXYZ", amount: 2300, currency_code: "usd" }],
})

{
  "offer": {
    "id": "offer_01HXYZ",
    "sku": "ACME-SHIRT-M",
    "manage_inventory": true,
    "allow_backorder": false,
    "prices": [
      { "id": "price_01HXYZ", "amount": 2300, "currency_code": "usd" }
    ]
  }
}

Updates the offer directly (no change request) and returns the refreshed offer.

Path parameters

string

required

The offer’s ID.

Body parameters

string

The seller’s SKU for this listing.

string

ID of the shipping profile used to fulfill the offer.

boolean

Whether stock is tracked for the offer. Set to false to sell without inventory checks.

boolean

Whether the offer can be purchased when it is out of stock.

object[]

Prices to upsert; include id to update an existing price, omit it to add one.

Show properties

string

Existing price ID to update.

number

required

Price amount.

string

required

Currency code, e.g. usd.

number

Minimum quantity for the price to apply; positive integer.

number

Maximum quantity for the price to apply; positive integer.

object

Price rules as attribute-to-value pairs.

object

Custom key-value pairs.

Response

object

Show properties

string

The offer’s ID.

string

The seller’s SKU for this listing.

string

ID of the shipping profile.

boolean

Whether stock is tracked for the offer.

boolean

Whether the offer can be purchased when it is out of stock.

object[]

The offer’s prices after the update.

object[]

Linked inventory items.

curl -X POST 'http://localhost:9000/vendor/offers/offer_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"prices": [{ "id": "price_01HXYZ", "amount": 2300, "currency_code": "usd" }]}'

const { offer } = await client.vendor.offers.$id.mutate({
  $id: "offer_01HXYZ",
  prices: [{ id: "price_01HXYZ", amount: 2300, currency_code: "usd" }],
})

{
  "offer": {
    "id": "offer_01HXYZ",
    "sku": "ACME-SHIRT-M",
    "manage_inventory": true,
    "allow_backorder": false,
    "prices": [
      { "id": "price_01HXYZ", "amount": 2300, "currency_code": "usd" }
    ]
  }
}

curl -X POST 'http://localhost:9000/vendor/offers/offer_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"prices": [{ "id": "price_01HXYZ", "amount": 2300, "currency_code": "usd" }]}'

const { offer } = await client.vendor.offers.$id.mutate({
  $id: "offer_01HXYZ",
  prices: [{ id: "price_01HXYZ", amount: 2300, currency_code: "usd" }],
})

{
  "offer": {
    "id": "offer_01HXYZ",
    "sku": "ACME-SHIRT-M",
    "manage_inventory": true,
    "allow_backorder": false,
    "prices": [
      { "id": "price_01HXYZ", "amount": 2300, "currency_code": "usd" }
    ]
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Body parameters

Response

​Path parameters

​Body parameters

​Response

Path parameters

Body parameters

Response