Documentation Standards

Each section of the JOOR API documentation is broken down by product function (styles, customers, orders, etc.) and then subsequently divided into the following sub-sections:

• Endpoint URLs
• Request Field Details
• Response Field Details
• Request Examples (XML & JSON)
• Response Examples (XML & JSON)

Dates

All date fields sent and received by the JOOR API must be in ISO 8601 format based on the UTC timezone. For information regarding ISO 8601 formatting, please visit the following: http://www.w3.org/TR/NOTE-datetime

Required Fields

Request fields will be documented with the following codes to designate whether or not they are required or are dependent on other fields (which will be noted in their respective descriptions).

Y = Yes, field is required
N = No, field is optional
X = May be required if other fields are supplied (for example an “end date” would be required if an optional “start date” is supplied). Review the field description for clarification on dependencies.

Supported Formats

The JOOR API supports XML and JSON formats depending on the type and method of the call being made. Each endpoint will specify the available formats within the documentation.

Clients should make use of HTTP headers to denote content type of the request being made. By default, the JOOR API will return the same format requested unless otherwise specified by either the “Accept” HTTP header or the optional “return_format” URL parameter.

Accepted HTTP Header Content MIME Types:

• application/xml
• application/json

🚧

Content MIME Type

You must provide a Content MIME Type in the header of requests to
invoke the API. Calls made without the Content MIME Type are not
processed.

Gateway Standards

🚧

Token must be Base64 encoded.

Your OAuth2 token must be Base64 encoded and passed in your Authorization Header.

All gateway calls to the JOOR API must be made via secure HTTP request via SSL. The JOOR API supports a modified OAuth2 Authentication Method. An OAuth2 token will be provided by JOOR. Please contact your account representative or account administrator to create or disable OAuth2 tokens.

In most cases, each reply from the JOOR API will include a “response” element consisting of a “code” and optional “comment” and a “log ID” representing the unique transaction ID as logged by the JOOR platform. A “0” response code denotes a successful gateway call and will not contain any comments. Any response code other than zero denotes an error. In the case of an error, the “comment” will contain a simple description of the problem. See RESPONSE CODES below for error details. Please note these are not HTTP response codes.

Response Codes