Admin API#
Integrate your backend operations, such as sending orders to us for fulfillment.Authentication#
All requests to the Admin API must include an x-api-key header with your API key. If you are using the Client SDKs, you will set the API key when constructing a client, and then the SDK will send the header on your behalf with every request. If integrating directly with the API, you'll need to send this header yourself.Content Types#
The Admin API always returns JSON in response bodies.Strict Schema#
Additional fields not specified in the schema will result in a validation error.Response Codes#
The API uses standard HTTP response codes to indicate the success or failure of requests:200 OK: The request was successful.
201 Created: The request was successful and a new resource was created.
400 Bad Request: The request was invalid or cannot be served. This occurs when the request doesn't match the schema or contains validation errors.
401 Unauthorized: The request lacks valid authentication credentials.
403 Forbidden: The server understood the request but refuses to authorize it.
404 Not Found: The requested resource could not be found.
500 Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request.
Modified at 2024-09-14 02:19:19
