All Versions

Version 1
Version 2


Page tree

Supplier API v2

Skip to end of metadata
Go to start of metadata

Table of Contents

Overview

POST requests are used to create new resources within the API. Consumers of this API have permission to create a limited set of resources. The documentation for each resource will indicate if it allows POST requests. If allowed, the documentation will specify which data elements are to be posted and which of those elements are required to have values provided.

Request Headers

The following headers should be used when issuing GET requests for resource lists

NameRequiredValueDescription
Authorizationif required for the requested resource typeBasic {Auth-Token}Your Basic HTTP Authorization token as described in Authentication.
Content-TypeRequired for all requestsapplication/jsonData format used for the body of the request. The API currently only supports JSON data in the request.
Content-VersionOptional (recommended){version number}Version of the resource being posted. Learn more about API Versioning.

Successful Responses

HTTP Status Codes

Successful calls to the endpoints will return an appropriate HTTP Status Code from the following list: 

HTTP Status CodeUsage

200: OK

All successful calls not otherwise specified

Headers

Header NameValueDescription

Content-Type

application/json

MIME type of the response body. Currently the API offers only JSON responses.

Content-Version{version number}Version of the resource being returned. Learn more about API Versioning.

Response Body 

The format of the response body will vary based on the potential of the request to match more than one resource. 

Requests that specify an identifier for the requested resource in the format of /resource/id will return at most one item. The response for these requests will always be an Item response type. You will never receive an empty Item response. Instead, if the requested identifier is not found, you will receive a 404: Not Found response.

Read more about the Item Response Model. 

If no identifier is specified in the request, such as /resource, then response will be a List response. The List format will be used even if the list contains only one item. If the list is empty, you will still receive a response in the List format with an empty _list array.

Read more about the List Response Model.

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.