Simulate

Simulate bulk ship shipping status

Changed on Nov 3, 2026

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

Request

Base URL
https://sandbox.api.caas.reap.global
Auth
API key in header x-reap-api-key
TypeScript
https://skmtc.dev/reap-global/apis/reap-api/docs/simulate/bulkships/:bulkshipID/shipping-status/post.ts
A function with typed inputs. Its response is checked against the schema.

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

Changes

Nov 3, 2026beb4b8d4eb01 Revision changes
- breaking
  added subschema #2 to the response body oneOf list for the response status

Operation history