Versions Compared

Key

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

...

The follwing APIs exist to support the order process.

APIIn paramsResponseProvider 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

<PriceProvider>

GetAvailability

Authentication information

A list of part numbers

List of availabilities for each part (if several warehouses)

Result codes

<AvailabilityProvider>
GetAddressesAuthentication information

List of addresses

List of order types

Temporary address permission (optional)

Result code

<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)

Error code on order

Error codes on order lines

Result codes

<PlaceOrderProvider>

GetOrderList

Authentication information

OrderHistoryLines, one line per order

Result codes

<OrderHistoryProvider>

GetOrderDetails

Authentication information

Order number

Order header, order lines, shipment lines

Result codes

<OrderDetailProvider>

Providers

Providers for integrations are normally custom built for each integration and params needed for each custom provider will vary. Typically a custom provider is configured according to the below pattern in profile.config:

...

Info
Use tracing files for first error search of APIs. See related article x article Error search order API for more information.

...

Page Properties
hiddentrue


Related issues