Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article describes the http APIs available to support the order process. It gives an overview of existing providers, and log tracing of API calls.

...

API

In params

Response

Provider name

GetPrice

Authentication information

A list of part numbers

Price and currency for each part.

NLA code for each part.

Replacement information for each part.

Result codes (message and error on each part)

<PriceProvider>

GetAvailability

Authentication information

A list of part numbers

List of availabilities for each part (if several warehouses)

Result codes (message and error on each part)

<AvailabilityProvider>

GetAddresses

Authentication information

List of addresses

List of order types

Temporary address permission (optional)

Result code (message and error on each address)

<AddressProvider>

AddToOrderCart

Authentication information

A list of part numbers

Order line results

Result codes

<AddToOrderCartProvider>

PlaceOrder / ValidateOrder

Authentication information

Order (header and order lines)

Order (updated if needed with NLA and replacements)

Result codes (message on order, error on order, message on order line, error on order lines)

<PlaceOrderProvider>

<ValidateOrderProvider> (version 5.0)

GetOrderTypes

Authentication information

List of Order Types

<PlaceOrderProvider>

<ValidateOrderProvider> (version 5.0)

GetDeliveryOptions

Authentication information

Order (header and order lines)

List of Delivery Options valid for the order

<PlaceOrderProvider>

<ValidateOrderProvider> (version 5.0)

GetOrders

Authentication information

Orders, one line per order

Result codes

<OrderHistoryProvider>

GetOrderDetails

Authentication information

Order number

Order header, order lines, shipment lines

Result codes

<OrderDetailProvider>

 Signin

ReturnUrl 

Success or failure status

 <AutenticateProvider>

 Authenticate

 SesssionId

 User record; name, id, permissions etc.

  <AutenticateProvider>

PlaceOrder / ValidateOrder

...