API Portal

Welcome to the API Portal.

This portal provides your point of access to the documentation and endpoints for the Web APIs available for this system.

Purpose

The APIs available here are the preferred method of integrating this system with other third-party systems and applications.

All APIs in this portal follow a single, consistent interaction model, they use common objects, naming schemes and documentation, giving developers and integrators a superior integration experience.

The APIs are stable, and backward compatibility is maintained across versions.

Available APIs

A list of the available APIs, their endpoints, interfaces and documentation is below.

Stores

Provides objects and methods for maintaining store information and related data.

Products

Provides objects and methods for maintaining products and availability.

Customers

Provides objects and methods for maintaining customers.

Single Sign-On

Provides objects and methods for basic customer creation, login, retrieval, and interest group subscription and unsubscription.

Orders

Provides objects and methods for maintaining orders.

Dispatch

Provides objects and methods for processing orders through dispatch.

Sales and Returns

Provides objects and methods for accessing historical sales and returns data.

Delivery

Provides objects and methods for retrieving delivery options.

Gift Registry

Provides objects and methods for accessing gift registries, and for recording sales and returns against a gift registry.

Shopping Cart

Provides programmatic access to shopping sessions, and functionality for placing orders with the system.

State

Provides access to basic state information about the current users' session.

Pricing

Provides access to customer specific pricing information on the current website and display state.

Item Pricing

Provides access to customer specific item pricing information on the current website and display state.

Events

Provides access to retrieve messages from the events system.

API concepts, objects and methods

Documentation on generic API concepts, objects and methods is available below. The generic objects may be returned from any API method, while the generic methods are available on all APIs.