curl 'http://localhost:9000/admin/offers/offer_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
{
"offer": {
"id": "offer_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
"seller_id": "sel_01HXYZ",
"variant_id": "variant_01HXYZ",
"product_id": "prod_01HXYZ",
"shipping_profile_id": "sp_01HXYZ",
"sku": "SHIRT-M-BLUE",
"ean": null,
"upc": null,
"created_by": "user_01HXYZ",
"variant_count": 3,
"metadata": null,
"seller": { "id": "sel_01HXYZ", "name": "Acme Store", "handle": "acme-store" },
"product_variant": { "id": "variant_01HXYZ", "title": "M / Blue", "sku": "SHIRT-M-BLUE" },
"shipping_profile": { "id": "sp_01HXYZ", "name": "Default" },
"prices": [
{ "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd", "min_quantity": null, "max_quantity": null }
],
"inventory_items": [
{ "id": "iitem_01HXYZ", "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1, "sku": "SHIRT-M-BLUE" }
]
}
}
Offers
Retrieve Offer
Retrieve an offer by ID.
GET
/
admin
/
offers
/
{id}
curl 'http://localhost:9000/admin/offers/offer_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
{
"offer": {
"id": "offer_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
"seller_id": "sel_01HXYZ",
"variant_id": "variant_01HXYZ",
"product_id": "prod_01HXYZ",
"shipping_profile_id": "sp_01HXYZ",
"sku": "SHIRT-M-BLUE",
"ean": null,
"upc": null,
"created_by": "user_01HXYZ",
"variant_count": 3,
"metadata": null,
"seller": { "id": "sel_01HXYZ", "name": "Acme Store", "handle": "acme-store" },
"product_variant": { "id": "variant_01HXYZ", "title": "M / Blue", "sku": "SHIRT-M-BLUE" },
"shipping_profile": { "id": "sp_01HXYZ", "name": "Default" },
"prices": [
{ "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd", "min_quantity": null, "max_quantity": null }
],
"inventory_items": [
{ "id": "iitem_01HXYZ", "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1, "sku": "SHIRT-M-BLUE" }
]
}
}
Returns a single offer with its seller, variant, shipping profile, prices, and inventory items.
Path parameters
The offer’s ID.
Query parameters
Comma-separated fields to include in the response.
Response
Show properties
Show properties
The offer’s ID.
ID of the seller who owns the offer.
ID of the offered product variant.
ID of the offered product.
ID of the offer’s shipping profile.
The offer’s SKU.
The offer’s EAN.
The offer’s UPC.
ID of the actor who created the offer.
Number of variants on the offered product.
Custom key-value data.
The seller, with
id, name, and handle.The variant, with
id, title, and sku.The shipping profile, with
id and name.Offer prices, each with
id, amount, currency_code, min_quantity, max_quantity, and price_rules.Linked inventory items, each with
id, inventory_item_id, required_quantity, and sku.Creation timestamp.
Last update timestamp.
curl 'http://localhost:9000/admin/offers/offer_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
{
"offer": {
"id": "offer_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
"seller_id": "sel_01HXYZ",
"variant_id": "variant_01HXYZ",
"product_id": "prod_01HXYZ",
"shipping_profile_id": "sp_01HXYZ",
"sku": "SHIRT-M-BLUE",
"ean": null,
"upc": null,
"created_by": "user_01HXYZ",
"variant_count": 3,
"metadata": null,
"seller": { "id": "sel_01HXYZ", "name": "Acme Store", "handle": "acme-store" },
"product_variant": { "id": "variant_01HXYZ", "title": "M / Blue", "sku": "SHIRT-M-BLUE" },
"shipping_profile": { "id": "sp_01HXYZ", "name": "Default" },
"prices": [
{ "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd", "min_quantity": null, "max_quantity": null }
],
"inventory_items": [
{ "id": "iitem_01HXYZ", "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1, "sku": "SHIRT-M-BLUE" }
]
}
}
⌘I