v1

latestOpenAPI 3.0.02026-08-04620256.0 KB
Simulate

Simulate bulk ship shipping status

post/simulate/bulkships/{bulkshipID}/shipping-status

Path parameters

bulkshipIDstring uuid required

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Request body

shippingStatus'CARD_SHIPPING_INFO_AVAILABLE' | 'CARD_IN_TRANSIT' | 'CARD_OUT_FOR_DELIVERY' | 'CARD_DELIVERED' | 'CARD_SHIPPING_ATTEMPT_FAILED' | 'CARD_SHIPPING_EXCEPTION' | 'CARD_SHIPPING_CANCELED' required

Response

Bulk ship shipping status simulated successfully

bulkshipIDstring required
shippingStatus'CARD_SHIPPING_INFO_AVAILABLE' | 'CARD_IN_TRANSIT' | 'CARD_OUT_FOR_DELIVERY' | 'CARD_DELIVERED' | 'CARD_SHIPPING_ATTEMPT_FAILED' | 'CARD_SHIPPING_EXCEPTION' | 'CARD_SHIPPING_CANCELED' required