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",
"prices": [
{ "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
],
"inventory_items": [
{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
]
}
}
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",
"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
The offer’s ID.
Query parameters
Comma-separated fields to include in the response. Prefix with
+/- to add to or remove from the defaults.Response
Show properties
Show properties
The offer’s ID.
ID of the owning seller.
ID of the listed product variant.
ID of the parent product.
ID of the shipping profile.
The seller’s SKU for this listing.
EAN barcode.
UPC barcode.
The seller with
id, name, and handle.The variant with
id, title, and sku.The shipping profile with
id and name.Offer prices with
id, amount, currency_code, min_quantity, max_quantity, and price_rules.Linked inventory items with
id, inventory_item_id, required_quantity, and sku.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",
"prices": [
{ "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
],
"inventory_items": [
{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
]
}
}
⌘I