REST API Documentation

Objective

To facilitate REST API integration for third party users.

 

Critical Knowledge

  • The user role’s permission determines whether or not they can access the resources behind the API.
  • Third party applications need to be first authenticated via OAuth 2.0 in order to access the REST API. Read more here: OAuth 2.0

REST API Documentation

API documentation can be added to the homepage footer by adding the suffix /api-documentation to the URL of the Seller Center page.

Example: http://sellercenter.venture.com/api-documentation

Area Description Image
Getting Started Area provides information regarding what steps are required to start REST API calls. The area is divided into the three following parts:

  1. “Introduction”: explanation of HTTP methods and steps to proceed
  2. “Authentication”: steps for the authentication process. More in REST API Authentication
  3. “Error codes & Responses”: explains components of the HTTP method in detail (e.g., HTTP status codes, error code, links, etc.)

All three areas can be defined in the CMS blocks in the content management area (rest_api_introduction, rest_api_authenticaton, rest_api_errors)

Errors definitions are placeholders and should not be removed.
Resources

Presents a list of calls grouped by area (e.g. order, finance, product, etc.)

By clicking on any HTTP method, (e.g. GET, POST), RAML specification collapse.
REST API Call Every call contains information about:

  1. “Request” contains detailed information about descriptions, URI parameters, security schema, scopes, and headers.
  2. “Response” contains multiple error messages that apply to the call.

Body:

 

Response:

 

Available Calls

At the moment the following api calls are available in Seller Center and ready to use:

  • Finance: Statements
  • Finance: Transactions
  • Orders
  • Shipment Providers