CreateReplacementShipmentForCollectInStore
Type: schema
Description
Replacement shipment payload when the customer collects the items from a store instead of having them delivered.
TypeScript Definition
typescript
CreateReplacementShipmentForCollectInStore: {{
/**
* @description Set to `collect-in-store` when the replacement is fulfilled via in-store pickup.
* @constant
*/
fulfillment_type?: "collect-in-store";
/** @description The warehouse holding the replacement items for in-store pickup. */
warehouse_id: string;
shipment_items: components["schemas"]["AdminShipmentItem"][];
/**
* @description Set to `manual` since in-store pickup is handled outside of an integrated carrier.
* @enum {unknown}
*/
shipping_option: "manual";
/** @description The manual shipping provider associated with the in-store pickup flow. */
shipping_provider_id: string;
/**
* @description The packing option for the replacement shipment.
* @enum {unknown}
*/
packing_option: "manual" | "auto";
/** @description The boxes for the replacement shipment. */
boxes?: components["schemas"]["ShipmentBox"][];
/** @description The reason for the replacement shipment. */
reason: string;
};
/**
* CreateReplacementShipmentWithAutoMethod
* @description Replacement shipment payload when fulfilling through an integrated carrier.
*/
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["AdminShipmentItem"] | AdminShipmentItem |
components["schemas"]["ShipmentBox"] | ShipmentBox |
OpenAPI Schema
json
{
"description": "Replacement shipment payload when the customer collects the items from a store instead of having them delivered.",
"type": "object",
"properties": {
"fulfillment_type": {
"description": "Set to `collect-in-store` when the replacement is fulfilled via in-store pickup.",
"type": "string",
"const": "collect-in-store"
},
"warehouse_id": {
"description": "The warehouse holding the replacement items for in-store pickup.",
"type": "string"
},
"shipment_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminShipmentItem"
}
},
"shipping_option": {
"description": "Set to `manual` since in-store pickup is handled outside of an integrated carrier.",
"enum": [
"manual"
]
},
"shipping_provider_id": {
"description": "The manual shipping provider associated with the in-store pickup flow.",
"type": "string"
},
"packing_option": {
"description": "The packing option for the replacement shipment.",
"enum": [
"manual",
"auto"
]
},
"boxes": {
"description": "The boxes for the replacement shipment.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentBox"
}
},
"reason": {
"description": "The reason for the replacement shipment.",
"type": "string"
}
},
"required": [
"warehouse_id",
"shipment_items",
"shipping_option",
"shipping_provider_id",
"packing_option",
"reason"
],
"title": "CreateReplacementShipmentForCollectInStore",
"x-tags": [
"Shipping"
]
}Auto-generated from OpenAPI spec and TypeScript definitions