Create Offer

POST

vendor

offers

curl -X POST 'http://localhost:9000/vendor/offers' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sku": "ACME-SHIRT-M",
    "variant_id": "variant_01HXYZ",
    "shipping_profile_id": "sp_01HXYZ",
    "prices": [{ "amount": 2500, "currency_code": "usd" }],
    "inventory_items": [
      {
        "required_quantity": 1,
        "stock_levels": [{ "location_id": "sloc_01HXYZ", "stocked_quantity": 100 }]
      }
    ]
  }'

const { offer } = await client.vendor.offers.mutate({
  sku: "ACME-SHIRT-M",
  variant_id: "variant_01HXYZ",
  shipping_profile_id: "sp_01HXYZ",
  prices: [{ amount: 2500, currency_code: "usd" }],
  inventory_items: [
    {
      required_quantity: 1,
      stock_levels: [{ location_id: "sloc_01HXYZ", stocked_quantity: 100 }],
    },
  ],
})

{
  "offer": {
    "id": "offer_01HXYZ",
    "seller_id": "sel_01HXYZ",
    "variant_id": "variant_01HXYZ",
    "product_id": "prod_01HXYZ",
    "shipping_profile_id": "sp_01HXYZ",
    "sku": "ACME-SHIRT-M",
    "manage_inventory": true,
    "allow_backorder": false,
    "prices": [
      { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
    ],
    "inventory_items": [
      { "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
    ]
  }
}

Creates the seller’s offer for a variant: the seller’s SKU, shipping profile, prices, and backing inventory.

A product can be listed by many sellers; the offer is what carries the seller’s own price and stock for a variant.

Query parameters

string

Comma-separated fields to include in the returned offer. Prefix with +/- to add to or remove from the defaults.

Body parameters

string

required

The seller’s SKU for this listing.

string

required

ID of the product variant being listed.

string

required

ID of the seller’s shipping profile used to fulfill the offer.

object[]

required

Inventory items backing the offer; at least one is required.

Show properties

string

Title for the created inventory item.

string

SKU for the created inventory item.

number

default:"1"

Units of the item consumed per sale; positive integer.

object[]

Show properties

string

required

Stock location ID.

number

required

Stocked quantity at the location; non-negative integer.

object[]

required

Offer prices; at least one is required.

Show properties

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, e.g. {"region_id": "reg_01..."}.

string

EAN barcode.

string

UPC barcode.

boolean

default:"true"

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

boolean

default:"false"

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

object

Custom key-value pairs.

Response

object

Show properties

string

The offer’s ID.

string

ID of the owning seller.

string

ID of the listed product variant.

string

ID of the parent product.

string

ID of the shipping profile.

string

The seller’s SKU for this listing.

boolean

Whether stock is tracked for the offer.

boolean

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

object[]

Offer prices with id, amount, currency_code, min_quantity, max_quantity, and price_rules.

object[]

Linked inventory items with id, inventory_item_id, required_quantity, and sku.

curl -X POST 'http://localhost:9000/vendor/offers' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sku": "ACME-SHIRT-M",
    "variant_id": "variant_01HXYZ",
    "shipping_profile_id": "sp_01HXYZ",
    "prices": [{ "amount": 2500, "currency_code": "usd" }],
    "inventory_items": [
      {
        "required_quantity": 1,
        "stock_levels": [{ "location_id": "sloc_01HXYZ", "stocked_quantity": 100 }]
      }
    ]
  }'

const { offer } = await client.vendor.offers.mutate({
  sku: "ACME-SHIRT-M",
  variant_id: "variant_01HXYZ",
  shipping_profile_id: "sp_01HXYZ",
  prices: [{ amount: 2500, currency_code: "usd" }],
  inventory_items: [
    {
      required_quantity: 1,
      stock_levels: [{ location_id: "sloc_01HXYZ", stocked_quantity: 100 }],
    },
  ],
})

{
  "offer": {
    "id": "offer_01HXYZ",
    "seller_id": "sel_01HXYZ",
    "variant_id": "variant_01HXYZ",
    "product_id": "prod_01HXYZ",
    "shipping_profile_id": "sp_01HXYZ",
    "sku": "ACME-SHIRT-M",
    "manage_inventory": true,
    "allow_backorder": false,
    "prices": [
      { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
    ],
    "inventory_items": [
      { "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
    ]
  }
}

curl -X POST 'http://localhost:9000/vendor/offers' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sku": "ACME-SHIRT-M",
    "variant_id": "variant_01HXYZ",
    "shipping_profile_id": "sp_01HXYZ",
    "prices": [{ "amount": 2500, "currency_code": "usd" }],
    "inventory_items": [
      {
        "required_quantity": 1,
        "stock_levels": [{ "location_id": "sloc_01HXYZ", "stocked_quantity": 100 }]
      }
    ]
  }'

const { offer } = await client.vendor.offers.mutate({
  sku: "ACME-SHIRT-M",
  variant_id: "variant_01HXYZ",
  shipping_profile_id: "sp_01HXYZ",
  prices: [{ amount: 2500, currency_code: "usd" }],
  inventory_items: [
    {
      required_quantity: 1,
      stock_levels: [{ location_id: "sloc_01HXYZ", stocked_quantity: 100 }],
    },
  ],
})

{
  "offer": {
    "id": "offer_01HXYZ",
    "seller_id": "sel_01HXYZ",
    "variant_id": "variant_01HXYZ",
    "product_id": "prod_01HXYZ",
    "shipping_profile_id": "sp_01HXYZ",
    "sku": "ACME-SHIRT-M",
    "manage_inventory": true,
    "allow_backorder": false,
    "prices": [
      { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
    ],
    "inventory_items": [
      { "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
    ]
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Body parameters

Response

​Query parameters

​Body parameters

​Response

Query parameters

Body parameters

Response