Order Entry FR

DOWNLOAD SPEC

Getting Started

Authentication

This API uses API keys to authenticate and allow access to the API.

Your API keys carry many privileges, so be sure to keep them secure!

To know more about the authentication process, have a look at the dedicated authentication documentation.

For any authentication request and to know if you are eligible for API onboarding, please contact your local SE API Manager or SE API Team at distributorapiportal.global@se.com

Services

Order EntryAPI includes 3 levels of services that are linked to a predefined account number and country:

- Get the status of an Order through all the steps of ordering. This is achieved using the status method.

- Validate the content of the order (Address and cart content) and get all the pricing details. This is achieved using the validate Order method.

- Submit the Order to mySE. This is achieved using the submit Order method.

How it works

Request structure: Input Parameters

URL for Order EntryAPI in Non-Prod environment:https://api.qa.se.com/v2/customer-order/system/myse-order-entry-fr

There are 3 endpoints. The request structure is detailed for each of the endpoints:

1.1.Validate an Order Entry(POST):https://api.qa.se.com/v2/customer-order/system/myse-order-entry-fr/order/validate

This API method is used to validate an order entry before it is submitted.

The API will then perform several validation steps:data types, mandatory parameters, various business rules depending on the country and/or purchaser account. Once completed, it will send the response back to the requester:

* if validation is successful, it sends back the order entry request object, optionally completed with additional information.

* if validation fails, the API sends back the order entry request object completed along with the detailed validation errors at request header and/or item level (see response code 200 for more details.)

Other error conditions not strictly related to the validation of the order entry request (e.g. invalid authentication token, invalid Business Unit, ...) are still applicable and managed by the usual error responses.

Once the order entry request is valid, the requester can then submit it using the "Submit order entry request" API method.1.2.Retrieve the order entry status (GET):https://api.qa.se.com/v2/customer-order/system/myse-order-entry-fr/orders/{order-id}/status

1.2 Retrieve the order entry status (GET): https://api.qa.se.com/v2/customer-order/system/myse-order-entry-fr/orders/{order-id}/status

Indicate in which status you are in the Order Entrysubmission.

1.3.Submit an Order (POST): https://api.qa.se.com/v2/customer-order/system/myse-order-entry-fr/orders/submit

This API method is used to submit an order entry request. The API will then perform several validation steps: data types, mandatory parameters, various business rules depending on the country and/or purchaser account).

Once completed, it will submit the Order Entry request.