shop.order.couriers
Returns list of available couriers and the selected courier for specified order ID.
Parameters
-
id
GET
Order ID.
-
format
GET
Optional
Sets response format. Available options:
json
(default),xml
.
Return value
Couriers’ data. The sub-array with each courier’s data contains values with the following keys:
- []['id'] int Courier ID.
- []['name'] string Courier name.
- []['enabled'] int Courier status (0 or 1).
- []['contact_id'] int ID of contact associated with the courier.
- []['create_datetime'] datetime Courier creation date and time.
- []['orders_processed'] int Number of orders processed by the courier.
- []['note'] string Note entered in courier settings.
- []['all_storefronts'] int Flag (0 or 1) denoting whether the courier is available for selection in the properties of orders associated with all storefronts.
- []['rights_order_edit'] int Flag (0 or 1) denoting whether the courier has access rights to edit orders in the mobile app.
- []['rights_customer_edit'] int Flag (0 or 1) denoting whether the courier has access rights to edit customers’ properties in the mobile app.
- []['photo'] int ID of the courier’s photo from the
wa_contact
table. - []['selected'] int Flag (0 or 1) denoting whether the courier is selected in the specified order’s properties.
- []['photo_url'] string Absolute URL of the courier image file.