ShipmentEventFields
Type: schema
Description
What shipment events carry beyond the shipment as the shipments list returns it: its items, its tracking link and dates, and its marketplace.
TypeScript Definition
typescript
ShipmentEventFields: {{
/** @description The shipment's reference number (same as `reference_number`). */
shipment_id: string;
/** @description The marketplace, on a seller store's copy of a marketplace shipment; otherwise `null`. */
marketplace_id: string | null;
/** @description Tax applied to the shipping charge, e.g. `GST`. */
shipping_tax_type: string | null;
/** @description Days the courier takes to deliver; the estimated delivery date is set from it when the shipment is scheduled. */
delivery_lead_time: number | null;
/**
* Format: date-time
* @description When the shipment's return window closes: 7 days after delivery. `null` until it is delivered.
*/
return_window: string | null;
/** Format: date-time */
revised_shipping_date: string | null;
tracking_url: string | null;
shipment_items: {
product_id: string;
/** @description `null` for products without variants. */
variant_id: string | null;
/** @description The seller's own product id, for an item of a marketplace order; otherwise `null`. */
seller_product_id: string | null;
/** @description The seller's own variant id, for an item of a marketplace order; otherwise `null`. */
seller_variant_id: string | null;
quantity: number;
/** @description Units shipped free of charge, on top of `quantity`. */
free_quantity: number;
}[];
};
/** ShipmentInfo */
}OpenAPI Schema
json
{
"title": "ShipmentEventFields",
"description": "What shipment events carry beyond the shipment as the shipments list returns it: its items, its tracking link and dates, and its marketplace.",
"type": "object",
"externalDocs": {
"url": "https://llm-docs.commercengine.io/storefront/schemas/ShipmentEventFields",
"description": "API reference for the ShipmentEventFields schema"
},
"required": [
"shipment_id",
"marketplace_id",
"shipping_tax_type",
"delivery_lead_time",
"return_window",
"revised_shipping_date",
"tracking_url",
"shipment_items"
],
"properties": {
"shipment_id": {
"description": "The shipment's reference number (same as `reference_number`).",
"type": "string"
},
"marketplace_id": {
"description": "The marketplace, on a seller store's copy of a marketplace shipment; otherwise `null`.",
"type": [
"string",
"null"
]
},
"shipping_tax_type": {
"description": "Tax applied to the shipping charge, e.g. `GST`.",
"type": [
"string",
"null"
]
},
"delivery_lead_time": {
"description": "Days the courier takes to deliver; the estimated delivery date is set from it when the shipment is scheduled.",
"type": [
"integer",
"null"
]
},
"return_window": {
"description": "When the shipment's return window closes: 7 days after delivery. `null` until it is delivered.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"revised_shipping_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"tracking_url": {
"type": [
"string",
"null"
]
},
"shipment_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"variant_id": {
"description": "`null` for products without variants.",
"type": [
"string",
"null"
]
},
"seller_product_id": {
"description": "The seller's own product id, for an item of a marketplace order; otherwise `null`.",
"type": [
"string",
"null"
]
},
"seller_variant_id": {
"description": "The seller's own variant id, for an item of a marketplace order; otherwise `null`.",
"type": [
"string",
"null"
]
},
"quantity": {
"type": "integer"
},
"free_quantity": {
"description": "Units shipped free of charge, on top of `quantity`.",
"type": "integer"
}
},
"required": [
"product_id",
"variant_id",
"seller_product_id",
"seller_variant_id",
"quantity",
"free_quantity"
]
}
}
}
}Auto-generated from OpenAPI spec and TypeScript definitions