1.0
OAS3
Данный API предоставляет сведения о текущем статусе заказа, график отгрузки заказа и список позиций в заказе с учетом параметров, переданных в запросе.
Возвращаемая информация зависит от зарегистрированной учетной записи.
Доступность по странам - Список стран, для которых мы уже протестировали производительность, доступность и время отклика API:
- Аргентина, Австралия, Бельгия, Бразилия, Болгария, Канада, Чили, Колумбия, Хорватия, Дания, Финляндия, Франция, Германия, Индия, Италия, Мексика, Нидерланды, Новая Зеландия, Норвегия, Перу, Португалия, Румыния, Словения, Испания, Швеция, Швейцария, Турция, Великобритания и США.
Если ваша страна не указана в списке, вы можете связаться с нами напрямую или с вашим контактным лицом Schneider (POC), чтобы узнать, доступен ли ваш API в этой стране.
Для получения доступа к API требуется пройти проверку подлинности oAuth, подробные сведения см. на портале.
- Данный API поддерживает разбивку на страницы. Ниже приведены сведения о порядке разбивки.
- Если в соответствии с параметрами запроса API возвращает очень длинный список позиций, во избежание перегрузки и возникновения задержки ответ разбивается на страницы.
- Можно настроить параметр запроса, указывающий количество позиций, возвращаемых в одном ответе API. (page-size<=100)
Примечание. Размер страницы по умолчанию — 10. - Каждый ответ API также возвращает такие параметры, как totalNumberOfRecords, totalNumberOfPages и pageNumber.
-
- totalNumberOfRecords: количество записей, возвращаемых в ответе согласно параметрам, переданным в запросе
-
- totalNumberOfPages: ожидаемое количество страниц в зависимости от текущего значения pageSize и общего количества записей. Например, если количество записей равно 100, а значение page-size — 10, страниц будет 10.
-
- pageNumber: какую страницу ответа вы хотите увидеть.
Параметры, поддерживаемые API:
|
Параметр |
Тип данных |
Описание |
Пример |
|
country |
string |
Код страны, для которой требуется указать сведения о заказе. |
US |
|
order-number |
string |
Номер заказа в системе ERP. Это может быть полное значение заказа или значение startingFrom |
AB12345 |
|
order-status |
string |
Текущий статус заказа в системе ERP |
Delivered |
|
page |
string |
Текущее количество страниц в зависимости от параметров numberOfRecords и page-size |
1 |
|
page-size |
string |
Ожидаемое количество записей в ответе |
10 |
|
item-number |
string |
Номер определенной позиции заказа |
79895 |
|
purchaser-id |
string |
10-значный или 5-значный идентификатор покупателя, используемый в mySE. |
1000006792 |
Данный API поддерживает 3 операции, как описано ниже:
| ResourcePath | Обязательные параметры | Дополнительные параметры | Ожидаемый ответ |
| /orders/{country} | country |
Order-number, order-status, page, page-size, purchaser-id |
Все заказы, связанные с учетной записью в запрошенной стране |
| /orders/{country}/{order-number}/{item-number}/shipment-schedules | Country, order-number, item-number |
purchaser-id |
Будет возвращен график отгрузки запрошенной позиции line-item заказа |
| /orders/{country}/{order-number} | Country, order-number |
Item-number, purchaser-id | Будут возвращены общие сведения и график отгрузки позиции/позиций заказа. |
