Testing
The 3PL API does not use a separate sandbox hostname or company account. Use your provisioned company slug and API key against the production base URL with test: true.
Use any graded or sealed item already available in your live inventory and send it through the normal shipping flow:
- Validate the destination with
/address. - Call
/rateswith an item from your live inventory andtest: true. - Select a returned
courier_id. - Call
/orderwith the same shipment data, any unique test value fortxHash, andtest: true. - Check the result through
/statusas usual.
{
"address": {
"name": "Integration Test",
"email": "developer@example.com",
"phone": "+1 212 555 0100",
"address_line_1": "123 Main Street",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country_alpha2": "US"
},
"certs": [{ "cert": "YOUR_LIVE_INVENTORY_CERT", "value": 100 }],
"test": true
}
Test Transaction Hash
Test orders do not require a real USDC payment or an on-chain transaction. The txHash can be any unique, non-empty test identifier; it does not need to be a valid blockchain transaction hash or relate to a payment.
{
"courierId": "courier-service-id-from-rates",
"txHash": "test-integration-20260803-001",
"test": true
}
DYLI still uses this value as the order's idempotency key, tracking_key, and /status lookup value. Use a new value for each test shipment, but reuse the same value when retrying the same request.
With test: true, /order validates the request and saves a simulated result in DYLI. It does not create a shipment, buy a label, send a shipment email, reduce inventory or record a sale. /rates still returns real carrier quotes. Leave test out, or send test: false, for normal customer shipments.
The response includes test: true, simulated: true, status: "test", and your test identifier as both shipment_id and tracking_key. easyship_shipment_id, label_url and tracking_url are null. /status returns status: "test", pending: false and no carrier tracking. There is nothing to ship or cancel.
Retry a test using the same identifier. Use a new identifier when switching between test and live shipments.
For a sealed-product test, replace certs with the normal products request using a live DYLI product id. Vault with DYLI creates and transfers blockchain assets and does not support test mode.
Never send test: true for a customer shipment.