FAQ

Is there a sandbox or test account?

No. The API works on your real account. To try things without saving anything, use POST /v1/orders/preview and POST /v1/shipments/estimate; reads never change anything.

Can I call the API from a web page or a mobile app?

No. The API sends no CORS headers, and a key in a web page or app is visible to anyone. Call it from your server.

I lost my key. Can I see it again?

No, keys are shown only once. Create a new key in Settings → API access and revoke the old one.

My key stopped working. Why?

It was revoked, API access was turned off for your account (403 api_not_enabled), the portal user who created it was deactivated (401 invalid_api_key), or that user must change a temporary password (403 account_action_required). See Authentication.

Are rate limits per key?

No, per account. All your keys share them. See Rate limits.

Does the API charge my wallet?

Creating orders doesn't charge it, but holds the estimated shipping and handling fee once the order's stock is fully reserved, and our warehouse charges the fee when it weighs the parcel. Purchase orders placed by auto purchase are paid from your wallet automatically when the balance covers them. See Charges and your wallet.

Can I pay, accept quotes or withdraw requests through the API?

Not yet. Use the portal for payments, top-ups, accepting or declining quotes and withdrawing requests.

Why did my sync return orders I already had?

The safety margin in Incremental sync makes some orders come back. Match them on id.

Which time zone are times in?

Times are UTC (ISO 8601 with Z). Fields that are only a date, such as paidOn and neededBy, are dates in China time (UTC+8).

Why are there no images in responses?

Images are only available in the portal for now.

I missed webhooks while my endpoint was down. Will you resend them?

Failed attempts are retried for a while (Webhook delivery and retries). Events from while an endpoint was turned off are not resent; catch up with the API.

Can I see the webhook signing secret again?

No. Create a new secret on the endpoint's page; it replaces the old one at once.

How many keys and endpoints can I have?

Up to 10 active keys and 5 webhook endpoints per account.

Who do I contact?

Your account manager. Quote the X-Request-Id of the request you are asking about.