Sandbox
Test-mode helpers for exercising integrations.
/api/v1/sandbox/resetClears all test-mode data for your account. Requires an fk_test_ key.
Authorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/sandbox/reset"{ "object": "sandbox", "reset": true}/api/v1/sandbox/statusAuthorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/sandbox/status"{ "object": "sandbox", "livemode": true, "counts": { "property1": 0, "property2": 0 }}/api/v1/sandbox/simulate/{event_type}Triggers a lifecycle event against test-mode data so you can exercise webhook handling without moving real freight.
Authorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Path Parameters
Event to simulate, e.g. shipment.delivered.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/sandbox/simulate/string"{ "object": "sandbox_simulation", "event_type": "string"}