SellerOrderState
Type: schema
Description
A seller's share of a marketplace order, as its seller.order.* events carry it: the marketplace order with only the seller's items, its totals worked out for them, and no payments. An order pushed to the seller also carries its created_at, modified_at and davai_order_id.
TypeScript Definition
typescript
SellerOrderState: {components["schemas"]["OrderState"] & {
/** @description The marketplace store the order was placed on. */
marketplace_store_id: string
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["OrderState"] | OrderState |
OpenAPI Schema
json
{
"title": "SellerOrderState",
"description": "A seller's share of a marketplace order, as its `seller.order.*` events carry it: the marketplace order with only the seller's items, its totals worked out for them, and no payments. An order pushed to the seller also carries its `created_at`, `modified_at` and `davai_order_id`.",
"externalDocs": {
"url": "https://llm-docs.commercengine.io/storefront/schemas/SellerOrderState",
"description": "API reference for the SellerOrderState schema"
},
"allOf": [
{
"$ref": "#/components/schemas/OrderState"
},
{
"type": "object",
"properties": {
"marketplace_store_id": {
"description": "The marketplace store the order was placed on.",
"type": "string"
},
"marketplace_order_number": {
"description": "The marketplace order's number.",
"type": "string"
},
"marketplace_event_id": {
"description": "The `event_id` of the marketplace order's event this one was derived from; for an order pushed to the seller, this event's own.",
"type": "string"
},
"created_at": {
"description": "When the order was placed. Only on an order pushed to the seller.",
"type": "string",
"format": "date-time"
},
"modified_at": {
"description": "When the order was last changed. Only on an order pushed to the seller.",
"type": "string",
"format": "date-time"
},
"davai_order_id": {
"description": "The order's id in the system the store's orders were imported from; `null` for an order placed on Commerce Engine. Only on an order pushed to the seller.",
"type": [
"integer",
"null"
]
}
},
"required": [
"marketplace_store_id",
"marketplace_order_number",
"marketplace_event_id"
]
}
]
}Auto-generated from OpenAPI spec and TypeScript definitions