Versions Compared

Old Version 2

changes.mady.by.user ruhshona.urakova (Unlicensed)

Saved on

compared with

New Version 3

changes.mady.by.user ruhshona.urakova (Unlicensed)

Saved on

Key

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

This method is used to get information about orders included in one consignment by its reference. For this method, API uses Данный метод используется для получения информации о заказах, входящих в групповой заказ по его идентификатору. Для получения статусов API использует структуру application/x-www-form-urlencoded as its acceptable request representation (Media Type), and the standard и стандартный HTTP-method метод POST.Input for getConsignment request


Входные данные запроса getConsignment

#
Attribute name
Название атрибута
Type
Тип
Mandatory
Обязательность
Description
Описание
1sessionID
string
текст
YesA session identifier that has been fetched from the server using authentication request
ДаИдентификатор сессии, полученный от сервера после запроса авторизации.
1consignmentReference
number
число
YesReference number of a consignment (a pair of linked P&D orders) in question.

...

ДаИдентификационный номер группового заказа (пара связанных заказов Pickup & Delivery).


Заголовки:

URL: /rest/2/distribution-api/orders/getConsignment

MethodМетод: POST

Acceptable request representationsСтруктура: application/x-www-form-urlencoded

All attributes should be sent in request parameters for this request.

Request parametersДля этого запроса все атрибуты должны находиться в параметрах запроса.

Параметры запроса:  sessionID=eca3b9f1afa24988834ceb5c6aafdcbf&consignmentReference=bo1*bo2*gsdfg


Example of Пример запроса getConsignment response:

Code Block
<?xml version='1.0' encoding='UTF-8'
standalone='yes' ?>
<apiResponse version="1.0">
<consignmentResponse>
<consignments>
<consignment consignmentReference="bo2">
<orders>
<order
referenceNumber="2311_3" linkType="PickupAndDelivery" status="NEW"/>
<order
referenceNumber="2311_4" linkType="PickupAndDelivery" status="NEW"/>
</orders>
</consignment>
<consignment consignmentReference="bo1">
<orders>
<order
referenceNumber="2311_1" linkType="PickupAndDelivery" status="NEW"/>
<order
referenceNumber="2311_2" linkType="PickupAndDelivery" status="NEW"/>
</orders>
</consignment>
</consignments>
</consignmentResponse>
</apiResponse>