Push declared stock for one of the calling vendor's offers

PATCH

/api/v1/vendor/stock/{offerId}

curl --request PATCH \
  --url https://api-omni.linra.net/api/v1/vendor/stock/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "declaredStockQuantity": 1, "declaredInStock": true }'

• Production (placeholder domain — the vendor Gateway facade is not yet deployed to this host; see the Getting started guide)
• Staging (placeholder domain)
• Local development (Gateway default port)

Applies availability/quantity INSTANTLY (no review gate) — on an Approved offer this propagates immediately to the linked supply option’s stock snapshot. Reachable for ANY of the vendor’s own offers regardless of submission source — stock is a real-world fact about the vendor’s own SKU, independent of which door the offer’s identity/cost entered through. A declared “in stock: false” with a stale positive quantity is still treated as unavailable. Idempotent: re-pushing the identical declared state is a pure no-op. Requires the Stock capability — grantable independently of Offers/Cost.

Authorizations

• vendorBearer

Parameters

Path Parameters

offerId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

declaredStockQuantity

integer

nullable

declaredInStock

boolean

Example^generated

{
  "declaredStockQuantity": 1,
  "declaredInStock": true
}

Responses

200

The offer with its declared stock updated.

Media typeapplication/json

object

state

required

string

payload

required

details

object

payload

required

object

id

string format: uuid

vendorId

string format: uuid

variantId

string format: uuid

nullable

status

string

Allowed values: Draft PendingMatch PendingReview Approved Rejected Withdrawn Suspended

source

string

Allowed values: Manual Import Api

vendorSku

string

nullable

vendorExternalId

string

nullable

cost

Always the NET (ex-VAT) figure.

number format: decimal

pendingCost

A cost change awaiting reviewer approval, if one is in flight. Null otherwise.

number format: decimal

nullable

costIsVatInclusive

Always false. Pair Cost with this value (false) on a write to safely resubmit it unchanged — this is the one entry mode that can never re-interpret an already-net figure as a fresh gross one. See costEnteredVatInclusive for how you actually entered it.

boolean

costEnteredVatInclusive

Display-only — the vendor’s actual original entry-mode preference (how Cost was declared: exclusive/net or inclusive/gross). NEVER accepted on a write; use costIsVatInclusive (always false) for that.

boolean

inputVatAmount

Your own input VAT on the current cost, back-derived when costEnteredVatInclusive is true.

number format: decimal

pendingInputVatAmount

number format: decimal

nullable

declaredStockQuantity

integer

nullable

declaredInStock

boolean

rawBrandName

string

nullable

rawProductName

string

nullable

rawConcentration

string

nullable

rawSizeMl

integer

nullable

rawDescription

string

nullable

syncPaused

boolean

autoPublishEligible

boolean

reviewedByUserId

string format: uuid

nullable

reviewedAt

string format: date-time

nullable

reviewReason

string

nullable

importBatchId

string format: uuid

nullable

supplyOptionId

string format: uuid

nullable

version

Optimistic-concurrency token (informational on this API — no vendor endpoint requires you to send it back).

integer

createdDate

string format: date-time

nullable

lastModifiedDate

string format: date-time

nullable

Example

{
  "state": "SUCCESS",
  "payload": {
    "status": "Draft",
    "source": "Manual"
  }
}

400

Request validation failed.

Media typeapplication/json

object

state

required

string

payload

details

object

Example

{
  "state": "NOT_FOUND_VENDOR_OFFER"
}

403

Your token doesn’t carry the capability this endpoint requires.

Media typeapplication/json

object

state

required

string

payload

details

object

Examples

ExamplemissingCapability

{
  "state": "FORBIDDEN_CAPABILITY_NOT_GRANTED",
  "payload": null,
  "details": {
    "requiredCapability": "Orders"
  }
}

404

Unknown offer id, or one belonging to another vendor.

Media typeapplication/json

object

state

required

string

payload

details

object

Examples

ExamplenotFound

{
  "state": "NOT_FOUND_VENDOR_OFFER",
  "payload": null,
  "details": {}
}

429

Too many requests. Retry after the Retry-After header (seconds).

Media typeapplication/json

object

state

required

string

payload

details

object

Example

{
  "state": "NOT_FOUND_VENDOR_OFFER"
}

Headers

Retry-After

integer

Seconds to wait before retrying.