Offers
Retrieve Offer
Retrieve one of the seller’s offers by its ID.
GET
/
vendor
/
offers
/
{id}
curl 'http://localhost:9000/vendor/offers/offer_01HXYZ' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
const { offer } = await client.vendor.offers.$id.query({
$id: "offer_01HXYZ",
})
{
"offer": {
"id": "offer_01HXYZ",
"seller_id": "sel_01HXYZ",
"variant_id": "variant_01HXYZ",
"product_id": "prod_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 }
]
}
}
Returns a single offer owned by the seller; requesting another seller’s offer fails.
Path parameters
string
required
The offer’s ID.
Query parameters
string
Comma-separated fields to include in the response. Prefix with
+/- to add to or remove from the defaults.Response
object
Show properties
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.
string
EAN barcode.
string
UPC barcode.
boolean
Whether stock is tracked for the offer.
boolean
Whether the offer can be purchased when it is out of stock.
object
The seller with
id, name, and handle.object
The variant with
id, title, and sku.object
The shipping profile with
id and name.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.object
Custom key-value pairs.
curl 'http://localhost:9000/vendor/offers/offer_01HXYZ' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
const { offer } = await client.vendor.offers.$id.query({
$id: "offer_01HXYZ",
})
{
"offer": {
"id": "offer_01HXYZ",
"seller_id": "sel_01HXYZ",
"variant_id": "variant_01HXYZ",
"product_id": "prod_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 }
]
}
}
⌘I
curl 'http://localhost:9000/vendor/offers/offer_01HXYZ' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
const { offer } = await client.vendor.offers.$id.query({
$id: "offer_01HXYZ",
})
{
"offer": {
"id": "offer_01HXYZ",
"seller_id": "sel_01HXYZ",
"variant_id": "variant_01HXYZ",
"product_id": "prod_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 }
]
}
}