Offers
Batch Offer Inventory Items
Link, update, or unlink inventory items on an offer.
POST
/
vendor
/
offers
/
{id}
/
inventory-items
/
batch
curl -X POST 'http://localhost:9000/vendor/offers/offer_01HXYZ/inventory-items/batch' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>' \
-H 'Content-Type: application/json' \
-d '{
"create": [{ "inventory_item_id": "iitem_01HABC", "required_quantity": 2 }],
"update": [{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }],
"delete": ["iitem_01HDEF"]
}'
const { offer, created, updated, deleted } =
await client.vendor.offers.$id.inventoryItems.batch.mutate({
$id: "offer_01HXYZ",
create: [{ inventory_item_id: "iitem_01HABC", required_quantity: 2 }],
update: [{ inventory_item_id: "iitem_01HXYZ", required_quantity: 1 }],
delete: ["iitem_01HDEF"],
})
{
"created": [
{ "inventory_item_id": "iitem_01HABC", "required_quantity": 2 }
],
"updated": [
{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
],
"deleted": ["iitem_01HDEF"],
"offer": {
"id": "offer_01HXYZ",
"sku": "ACME-SHIRT-M",
"inventory_items": [
{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 },
{ "inventory_item_id": "iitem_01HABC", "required_quantity": 2 }
]
}
}
Manages the inventory items backing an offer in one request and returns the refreshed offer.
Path parameters
string
required
The offer’s ID.
Body parameters
object[]
object[]
string[]
Inventory item IDs to unlink from the offer.
Response
object[]
Links created by this request.
object[]
Links updated by this request.
string[]
Inventory item IDs unlinked by this request.
object
Show properties
Show properties
curl -X POST 'http://localhost:9000/vendor/offers/offer_01HXYZ/inventory-items/batch' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>' \
-H 'Content-Type: application/json' \
-d '{
"create": [{ "inventory_item_id": "iitem_01HABC", "required_quantity": 2 }],
"update": [{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }],
"delete": ["iitem_01HDEF"]
}'
const { offer, created, updated, deleted } =
await client.vendor.offers.$id.inventoryItems.batch.mutate({
$id: "offer_01HXYZ",
create: [{ inventory_item_id: "iitem_01HABC", required_quantity: 2 }],
update: [{ inventory_item_id: "iitem_01HXYZ", required_quantity: 1 }],
delete: ["iitem_01HDEF"],
})
{
"created": [
{ "inventory_item_id": "iitem_01HABC", "required_quantity": 2 }
],
"updated": [
{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
],
"deleted": ["iitem_01HDEF"],
"offer": {
"id": "offer_01HXYZ",
"sku": "ACME-SHIRT-M",
"inventory_items": [
{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 },
{ "inventory_item_id": "iitem_01HABC", "required_quantity": 2 }
]
}
}
⌘I
curl -X POST 'http://localhost:9000/vendor/offers/offer_01HXYZ/inventory-items/batch' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>' \
-H 'Content-Type: application/json' \
-d '{
"create": [{ "inventory_item_id": "iitem_01HABC", "required_quantity": 2 }],
"update": [{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }],
"delete": ["iitem_01HDEF"]
}'
const { offer, created, updated, deleted } =
await client.vendor.offers.$id.inventoryItems.batch.mutate({
$id: "offer_01HXYZ",
create: [{ inventory_item_id: "iitem_01HABC", required_quantity: 2 }],
update: [{ inventory_item_id: "iitem_01HXYZ", required_quantity: 1 }],
delete: ["iitem_01HDEF"],
})
{
"created": [
{ "inventory_item_id": "iitem_01HABC", "required_quantity": 2 }
],
"updated": [
{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
],
"deleted": ["iitem_01HDEF"],
"offer": {
"id": "offer_01HXYZ",
"sku": "ACME-SHIRT-M",
"inventory_items": [
{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 },
{ "inventory_item_id": "iitem_01HABC", "required_quantity": 2 }
]
}
}