Borzo Business API 1.6

Requests

All requests to Business API must be made via HTTPS. Only GET and POST request methods are supported. POST requests should send all parameters in the body of the request in JSON format and UTF-8 encoding; GET requests should send parameters in the query string.

All requests must include a HTTP header X-DV-Auth-Token.

• X-DV-Auth-Token string Required

  Secret auth token. Must be sent as a HTTP header.

  Your auth token can be found in your Personal cabinet.

  Important! Never put your auth token in any public places!
  If your token is compromised, it will be possible for anybody to place orders in your name.
  Tokens can be changed in your Personal cabinet.

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' 'https://robotapitest-br.borzodelivery.com/api/business/1.6' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true } 

Responses

Business API responses are in JSON format and UTF-8 encoding.

Successful responses will have HTTP code 200 (OK). Response JSON will always have is_successful field.

• is_successful boolean

  Whether the request was successful or not.

  Successful responses will have true here.

If there was an error, API response will have HTTP code 400 (Bad Request). The response JSON will have the following fields:

• is_successful boolean

  Whether the request was successful or not.

  In case of any errors it will be false.

• errors list

  List of error codes.

  Request error codes

• parameter_errors object / null

  Error codes for request parameters. If errors field contains error code invalid_parameters, this field will have detailed parameter errors. Structure of this object corresponds to structure of the request.

  Parameter error codes

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"points":[{"address":"R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020","contact_person":{"phone":"5511900000001"}},{}]}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/create-order' 

HTTP/1.1 400 Bad Request Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": false,     "errors": ["invalid_parameters"],     "parameter_errors": {         "matter": ["required"],         "points": [             null,             {                 "address": ["required"],                 "contact_person": {                     "phone": ["required"]                 }             }         ]     } } 

Parameter data types

• boolean

  Boolean value: true or false.

• integer

  Integer number without fractions.

• string

  A JSON string. Example: "active".

• date

  Date according to ISO 8601: YYYY-MM-DD. Example: "2024-11-23".

• timestamp

  Date and time according to ISO 8601: YYYY-MM-DDTHH:MM:SSZ. Example: "2024-11-23T09:38:35-03:00".

  Please use this exact format with semicolon in the timezone. Other ISO 8601 variants are not supported by Business API.

• float

  Floating point number with fractional part.

• list

  A JSON list. Example: [{"address":"R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020"}, {"address":"Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100"}].

• object

  A JSON object. Example: {"address":"R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020"}.

• money

  Money amount (R$), rounded to 2 decimal places. Examples: "190.00", "-49.90".

  This is a JSON string to prevent rounding errors.

• phone

  A JSON string with phone number. Example: "5511900000001".

• coordinate

  A JSON string with coordinate. Example: "-23.5962988".

• null

  Empty value: null.

API methods

Order price calculation

Use this method to calculate order prices and validate parameters before actually placing the order. It is possible to calculate an incomplete order, but such calculations may be imprecise.

In response to an empty request this method will respond with minimal order price.

• Request parameters
• Response parameters
• Examples

Request parameters

• type string

  Order type.

  Default value: "standard".

  Order types

• matter string / null Required

  Delivery contents. Maximum length is 5,000 characters.

  Try to make this description useful for the courier. For example, putting a category from your catalog here is better than only a concrete model number. If the item is fragile or oversized, please mention it here.

  Default value: null.

• vehicle_type_id integer

  Vehicle type.

  For orders of type standard

  Default value: 8 (Motorbike).
  

  Vehicle types

• total_weight_kg integer

  Total weight in kilograms.

  For orders of type standard

  Default value: <code>0</code>.
  

• insurance_amount money

  Insured amount.

  Default value: "0.00".

• is_client_notification_enabled boolean

  Whether to send SMS notifications to the client.

  Default value: false.

• is_contact_person_notification_enabled boolean

  Whether to send SMS notifications to recipients on addresses.

  Default value: false.

• is_route_optimizer_enabled boolean

  Automatically optimize route (addresses will be arranged in the optimal order).

  Default value: false.

• loaders_count integer

  Number of necessary loaders to move the delivered goods, including the driver. Maximum is 11.

  Default value: 0.

• backpayment_details string / null

  Details of the money transfer for backpayment. A credit card number or other payment system information. Maximum length is 300 characters.

  Default value: null.

• is_motobox_required boolean

  Is motobox required.

  Default value: false.

• is_thermobox_required boolean

  Is thermobox required.

  Default value: false.

• payment_method string

  Payment method (if different from default).

  Default value: null.

  Payment methods

• bank_card_id integer

  Bank card ID (required for bank_card payment method).

  Default value: null.

• promo_code string / null

  Promo code.

  Default value: null.

• points list Required

  List of addresses (points) for the courier to visit.

  For orders of type standard

  Maximum is 99 points. Default value: <code>[]</code>.
  

  Point parameters

  • address string / null Required

    Street address. Maximum length is 350 characters.

    We use Google Maps API to geocode addresses.

    Default value: null.

  • contact_person object Required

    Contact person on the address.

    Contact person parameters

    • phone phone / null Required

      Phone number of the person at the address.

      Default value: null.

    • name string / null

      Name of the person on the address. Maximum length is 350 characters.

      Default value: null.

  • client_order_id string / null

    Your eshop's order ID. It will be sent in notifications instead of our delivery order ID. Maximum length is 32 characters.

    Default value: null.

  • latitude coordinate / null

    Latitude of the location.

    Default value: null.

  • longitude coordinate / null

    Longitude of the location.

    Default value: null.

  • required_start_datetime timestamp / null

    How early the courier may arrive at the address.

    Default value: null.

  • required_finish_datetime timestamp / null

    How late the courier may arrive at the address.

    Default value: null.

  • taking_amount money

    Backpayment sum to receive from the contact person at the address.

    Default value: "0.00".

  • buyout_amount money

    Buyout sum the courier pays to the contact person at the address.

    Default value: "0.00".

  • note string / null

    Additional information for the courier: office or appartment number, company name, whether any documents are required to enter the building.

    Default value: null.

  • is_order_payment_here boolean

    Money will be paid to the courier at the address.

    Default value: false.

  • building_number string / null

    Building number.

    Default value: null.

  • entrance_number string / null

    Entrance number.

    Default value: null.

  • intercom_code string / null

    Intercom code.

    Default value: null.

  • floor_number string / null

    Floor number.

    Default value: null.

  • apartment_number string / null

    Apartment/office number.

    Default value: null.

  • invisible_mile_navigation_instructions string / null

    Instruction to courier how to get to recipient at the address.

    Default value: null.

  • is_cod_cash_voucher_required boolean

    Whether to issue a cashier's check to the recipient at the point. If true, you should fill list of packages at the point packages.

    Default value: false.

  • delivery_id integer / null

    Unique delivery ID (except first point).

    Default value: null.

  • packages list

    List of packages at the point.

    Default value: [].

    Package parameters

    • ware_code string

      Vendor code. Maximum length is 255 characters.

      Default value: null.

    • description string

      Description. Maximum length is 1000 characters.

      Default value: null.

    • items_count float

      Amount.

      Default value: 0.

    • item_payment_amount string

      Price per item.

      Default value: "0.00".

    • nomenclature_code string

      Nomenclature code. Maximum length is 255 characters.

      Default value: null.

Response parameters

• is_successful boolean

  Whether the request was successful or not.

• order object

  Calculated order data.

  Order parameters

  • type string

    Order type.

    Order types

  • matter string / null

    Delivery contents.

  • vehicle_type_id integer

    Vehicle type.

    Vehicle types

  • total_weight_kg integer

    Total weight in kilograms.

  • is_client_notification_enabled boolean

    Whether to send SMS notifications to the client.

  • is_contact_person_notification_enabled boolean

    Whether to send SMS notifications to recipients on addresses.

  • loaders_count integer

    Number of necessary loaders to move the delivered goods, including the driver.

  • points list

    List of addresses (points) for the courier to visit.

    Point parameters

    • address string / null

      Street address.

    • contact_person object

      Contact person on the address.

      Contact person parameters

      • phone phone / null

        Phone number of the person at the address.

      • name string / null

        Name of the person on the address.

    • client_order_id string / null

      Your eshop's order ID. It will be sent in notifications instead of our delivery order ID.

    • latitude coordinate / null

      Latitude of the location.

    • longitude coordinate / null

      Longitude of the location.

    • required_start_datetime timestamp / null

      How early the courier may arrive at the address.

    • required_finish_datetime timestamp / null

      How late the courier may arrive at the address.

    • taking_amount money

      Backpayment sum to receive from the contact person at the address.

    • buyout_amount money

      Buyout sum the courier pays to the contact person at the address.

    • note string / null

      Additional information for the courier: office or appartment number, company name, whether any documents are required to enter the building.

    • packages list

      List of packages at the point.

      Package parameters

      • ware_code string

        Vendor code.

      • description string

        Description.

      • items_count float

        Amount.

      • item_payment_amount string

        Price per item.

      • nomenclature_code string

        response.calculate_order.params.points.packages.nomenclature_code

    • is_cod_cash_voucher_required boolean

      Whether to issue a cashier's check to the recipient at the point.

    • is_order_payment_here boolean

      Money will be paid to the courier at the address.

    • building_number string / null

      Building number.

    • entrance_number string / null

      Entrance number.

    • intercom_code string / null

      Intercom code.

    • floor_number string / null

      Floor number.

    • apartment_number string / null

      Apartment/office number.

    • invisible_mile_navigation_instructions string / null

      Instruction to courier how to get to recipient at the address.

    • place_photo_url string / null

      Place photo when closing a point at the address.

    • sign_photo_url string / null

      Recipients signature photo when closing a point at the address.

    • checkin object / null

      Checkin information when closing a point at the address.

      Checkin parameters

      • recipient_full_name string / null

        Full name of the recipient who met the courier.

      • recipient_position string / null

        Position of the recipient who met the courier.

    • tracking_url string / null

      Recipient's tracking link.

    • delivery object / null

      Delivery.

      Delivery parameters

      • status string / null

        Delivery status.

  • payment_amount money / null

    Order price.

  • delivery_fee_amount money / null

    Delivery fee.

    Part of order price (payment_amount).

  • weight_fee_amount money / null

    Large weight fee.

    Part of order price (payment_amount).

  • insurance_amount money / null

    Insured amount.

  • insurance_fee_amount money / null

    Insurance fee.

    Part of order price (payment_amount).

  • loading_fee_amount money / null

    Loading / heavy lifting fee.

    Part of order price (payment_amount).

  • money_transfer_fee_amount money / null

    Money handling fee: backpayment transfer, buyout operations.

    Part of order price (payment_amount).

  • promo_code_discount_amount money / null

    Discount amount by promo code.

    Part of order price (payment_amount).

  • cod_fee_amount money / null

    Extra fee for issuing a cashier's check.

    Part of order price (payment_amount).

  • return_fee_amount money / null

    Extra fee for return to first point.

    Part of order price (payment_amount).

  • waiting_fee_amount money / null

    Extra fee for paid waiting at designated points.

    Part of order price (payment_amount).

  • backpayment_details string / null

    Details of the money transfer for backpayment. A credit card number or other payment system information.

  • is_motobox_required boolean

    Is motobox required.

  • is_thermobox_required boolean

    Is thermobox required.

  • applied_promo_code string / null

    Applied promo code.

• warnings list

  Warnings. You will receive these warnings as error codes if you try to create an order with the same data you calculated it with. Empty list of warnings means the order data is valid.

  Request error codes

• parameter_warnings object

  Parameter warnings. You will receive these warnings as parameter error codes if you try to create an order with the same data you calculated it with.

  Parameter error codes

Request example

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"matter":"Documents","points":[{"address":"R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020"},{"address":"Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100"}]}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/calculate-order' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": null,         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": null,         "status_description": null,         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": null,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": "2024-11-23T10:08:35-03:00"             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": null             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": null,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": "2024-11-23T11:08:35-03:00"             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": null             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     },     "warnings": ["invalid_parameters"],     "parameter_warnings": {         "points": [{             "contact_person": {                 "phone": ["required"]             }         }, {             "contact_person": {                 "phone": ["required"]             }         }]     } } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/calculate-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'matter' => 'Documents',     'points' => [         [             'address' => 'R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020',         ],         [             'address' => 'Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100',         ],     ], ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": null,         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": null,         "status_description": null,         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": null,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": "2024-11-23T10:08:35-03:00"             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": null             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": null,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": "2024-11-23T11:08:35-03:00"             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": null             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     },     "warnings": ["invalid_parameters"],     "parameter_warnings": {         "points": [{             "contact_person": {                 "phone": ["required"]             }         }, {             "contact_person": {                 "phone": ["required"]             }         }]     } } 

Placing an order

This API method creates a new delivery order.

• Request parameters
• Response parameters
• Examples

Request parameters

• type string

  Order type.

  Default value: "standard".

  Order types

• matter string Required

  Delivery contents. Maximum length is 5,000 characters.

  Try to make this description useful for the courier. For example, putting a category from your catalog here is better than only a concrete model number. If the item is fragile or oversized, please mention it here.

• vehicle_type_id integer

  Vehicle type.

  For orders of type standard

  Default value: 8 (Motorbike).
  

  Vehicle types

• total_weight_kg integer

  Total weight in kilograms.

  For orders of type standard

  Default value: <code>0</code>.
  

• insurance_amount money

  Insured amount.

  Default value: "0.00".

• is_client_notification_enabled boolean

  Whether to send SMS notifications to the client.

  Default value: false.

• is_contact_person_notification_enabled boolean

  Whether to send SMS notifications to recipients on addresses.

  Default value: false.

• is_route_optimizer_enabled boolean

  Automatically optimize route (addresses will be arranged in the optimal order).

  Default value: false.

• loaders_count integer

  Number of necessary loaders to move the delivered goods, including the driver. Maximum is 11.

  Default value: 0.

• backpayment_details string / null

  Details of the money transfer for backpayment. A credit card number or other payment system information. Maximum length is 300 characters.

  Default value: null.

• is_motobox_required boolean

  Is motobox required.

  Default value: false.

• is_thermobox_required boolean

  Is thermobox required.

  Default value: false.

• payment_method string

  Payment method (if different from default).

  Default value: null.

  Payment methods

• bank_card_id integer

  Bank card ID (required for bank_card payment method).

  Default value: null.

• promo_code string / null

  Promo code.

  Default value: null.

• is_return_required boolean

  Need to create order with return.

  Default value: false.

• points list Required

  List of addresses (points) for the courier to visit.

  For orders of type standard

  Maximum is 99 points. Default value: <code>[]</code>.
  

  Point parameters

  • address string Required

    Street address. Maximum length is 350 characters.

    We use Google Maps API to geocode addresses.

  • contact_person object Required

    Contact person on the address.

    Contact person parameters

    • phone phone Required

      Phone number of the person at the address.

    • name string / null

      Name of the person on the address. Maximum length is 350 characters.

      Default value: null.

  • client_order_id string / null

    Your eshop's order ID. It will be sent in notifications instead of our delivery order ID. Maximum length is 32 characters.

    Default value: null.

  • latitude coordinate / null

    Latitude of the location.

    Default value: null.

  • longitude coordinate / null

    Longitude of the location.

    Default value: null.

  • required_start_datetime timestamp / null

    How early the courier may arrive at the address.

    Default value: null.

  • required_finish_datetime timestamp / null

    How late the courier may arrive at the address.

    Default value: null.

  • taking_amount money

    Backpayment sum to receive from the contact person at the address.

    Default value: "0.00".

  • buyout_amount money

    Buyout sum the courier pays to the contact person at the address.

    Default value: "0.00".

  • note string / null

    Additional information for the courier: office or appartment number, company name, whether any documents are required to enter the building.

    Default value: null.

  • is_order_payment_here boolean

    Money will be paid to the courier at the address.

    Default value: false.

  • building_number string / null

    Building number.

    Default value: null.

  • entrance_number string / null

    Entrance number.

    Default value: null.

  • intercom_code string / null

    Intercom code.

    Default value: null.

  • floor_number string / null

    Floor number.

    Default value: null.

  • apartment_number string / null

    Apartment/office number.

    Default value: null.

  • invisible_mile_navigation_instructions string / null

    Instruction to courier how to get to recipient at the address.

    Default value: null.

  • is_cod_cash_voucher_required boolean

    Whether to issue a cashier's check to the recipient at the point. If true, you should fill list of packages at the point packages.

    Default value: false.

  • delivery_id integer / null

    Unique delivery ID (except first point).

    Default value: null.

  • packages list

    List of packages at the point.

    Default value: [].

    Package parameters

    • ware_code string

      Vendor code. Maximum length is 255 characters.

      Default value: null.

    • description string

      Description. Maximum length is 1000 characters.

      Default value: null.

    • items_count float

      Amount.

      Default value: 0.

    • item_payment_amount string

      Price per item.

      Default value: "0.00".

    • nomenclature_code string

      Nomenclature code. Maximum length is 255 characters.

      Default value: null.

Response parameters

• is_successful boolean

  Whether the request was successful or not.

• order object

  The created order.

  Order parameters

  • order_id integer

    Full order ID.

  • type string

    Order type.

    Order types

  • matter string

    Delivery contents.

  • order_name string

    Order name (short order ID).

  • vehicle_type_id integer

    Vehicle type.

    Vehicle types

  • created_datetime timestamp

    Order creation date and time.

  • finish_datetime timestamp / null

    Order completion date and time.

  • status string

    Order status.

    Order statuses

  • status_description string

    Order status description.

  • total_weight_kg integer

    Total weight in kilograms.

  • is_client_notification_enabled boolean

    Whether to send SMS notifications to the client.

  • is_contact_person_notification_enabled boolean

    Whether to send SMS notifications to recipients on addresses.

  • loaders_count integer

    Number of necessary loaders to move the delivered goods, including the driver.

  • points list

    List of addresses (points) for the courier to visit.

    Point parameters

    • point_id integer

      Point ID.

    • delivery_id integer / null

      Delivery ID.

    • address string

      Street address.

    • contact_person object

      Contact person on the address.

      Contact person parameters

      • phone phone

        Phone number of the person at the address.

      • name string / null

        Name of the person on the address.

    • client_order_id string / null

      Your eshop's order ID. It will be sent in notifications instead of our delivery order ID.

    • latitude coordinate

      Latitude of the location.

    • longitude coordinate

      Longitude of the location.

    • required_start_datetime timestamp / null

      How early the courier may arrive at the address.

    • required_finish_datetime timestamp / null

      How late the courier may arrive at the address.

    • arrival_start_datetime timestamp / null

      Estimated courier arrival time, upper bound.

    • arrival_finish_datetime timestamp / null

      Estimated courier arrival time, lower bound.

    • courier_visit_datetime timestamp / null

      Actual courier arrival time.

    • taking_amount money

      Backpayment sum to receive from the contact person at the address.

    • buyout_amount money

      Buyout sum the courier pays to the contact person at the address.

    • note string / null

      Additional information for the courier: office or appartment number, company name, whether any documents are required to enter the building.

    • packages list

      List of packages at the point.

      Package parameters

      • order_package_id integer

        Package ID.

      • ware_code string

        Vendor code.

      • description string

        Description.

      • items_count float

        Amount.

      • item_payment_amount string

        Price per item.

      • nomenclature_code string

        Nomenclature code.

    • is_cod_cash_voucher_required boolean

      Whether to issue a cashier's check to the recipient at the address.

    • is_order_payment_here boolean

      Money will be paid to the courier at the address.

    • building_number string / null

      Building number.

    • entrance_number string / null

      Entrance number.

    • intercom_code string / null

      Intercom code.

    • floor_number string / null

      Floor number.

    • apartment_number string / null

      Apartment/office number.

    • invisible_mile_navigation_instructions string / null

      Instruction to courier how to get to recipient at the address.

    • place_photo_url string / null

      Place photo when closing a point at the address.

    • sign_photo_url string / null

      Recipients signature photo when closing a point at the address.

    • checkin_code string / null

      Courier's arrival pin code at the point.

    • checkin object / null

      Checkin information when closing a point at the address.

      Checkin parameters

      • recipient_full_name string / null

        Full name of the recipient who met the courier.

      • recipient_position string / null

        Position of the recipient who met the courier.

    • is_return_point boolean

      Return point (same as first or hub).

    • tracking_url string / null

      Recipient's tracking link.

    • delivery object / null

      Delivery.

      Delivery parameters

      • status string

        Delivery status.

  • payment_amount money / null

    Order price.

  • delivery_fee_amount money / null

    Delivery fee.

    Part of order price (payment_amount).

  • weight_fee_amount money / null

    Large weight fee.

    Part of order price (payment_amount).

  • insurance_amount money / null

    Insured amount.

  • insurance_fee_amount money / null

    Insurance fee.

    Part of order price (payment_amount).

  • loading_fee_amount money / null

    Loading / heavy lifting fee.

    Part of order price (payment_amount).

  • money_transfer_fee_amount money / null

    Money handling fee: backpayment transfer, buyout operations.

    Part of order price (payment_amount).

  • cod_fee_amount money / null

    Extra fee for issuing a cashier's check.

    Part of order price (payment_amount).

  • return_fee_amount money / null

    Extra fee for return to first point.

    Part of order price (payment_amount).

  • waiting_fee_amount money / null

    Extra fee for paid waiting at designated points.

    Part of order price (payment_amount).

  • backpayment_details string / null

    Details of the money transfer for backpayment. A credit card number or other payment system information.

  • backpayment_photo_url string / null

    URL of backpayment photo (receipt or other payment verification).

  • itinerary_document_url string / null

    URL of itinerary document.

  • waybill_document_url string / null

    URL of waybill document.

  • courier object / null

    Courier parameters.

    Courier parameters

    • courier_id integer

      Courier ID.

    • surname string

      Surname of the courier.

    • name string

      Name of the courier.

    • middlename string

      Middlename of the courier.

    • phone phone

      Phone of the courier.

    • photo_url string / null

      URL of the courier's photo.

    • latitude coordinate / null

      Latitude of the location.

      Only for active orders, if the courier is on the way.

    • longitude coordinate / null

      Longitude of the location.

      Only for active orders, if the courier is on the way.

  • is_motobox_required boolean

    Is motobox required.

  • is_thermobox_required boolean

    Is thermobox required.

  • payment_method string

    Payment method.

    Payment methods

  • bank_card_id integer / null

    Bank card ID for bank_card payment method.

  • applied_promo_code string / null

    Applied promo code.

  • is_return_required boolean

    Order has return.

  • promo_code_discount_amount money

    Discount amount by promo code.

    Part of order price (payment_amount).

Request example

Example 1. Create order with default payment method.

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"matter":"Documents","points":[{"address":"R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020","contact_person":{"phone":"5511900000001"}},{"address":"Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100","contact_person":{"phone":"5511900000001"}}]}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/create-order' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     } } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/create-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'matter' => 'Documents',     'points' => [         [             'address' => 'R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020',             'contact_person' => [                 'phone' => '5511900000001',             ],         ],         [             'address' => 'Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100',             'contact_person' => [                 'phone' => '5511900000001',             ],         ],     ], ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     } } 

Example 2. Create order with bank_card payment method.

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"matter":"Documents","payment_method":"bank_card","bank_card_id":80,"points":[{"address":"R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020","contact_person":{"phone":"5511900000001"}},{"address":"Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100","contact_person":{"phone":"5511900000001"}}]}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/create-order' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "bank_card",         "bank_card_id": 80,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     } } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/create-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'matter' => 'Documents',     'payment_method' => 'bank_card',     'bank_card_id' => 80,     'points' => [         [             'address' => 'R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020',             'contact_person' => [                 'phone' => '5511900000001',             ],         ],         [             'address' => 'Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100',             'contact_person' => [                 'phone' => '5511900000001',             ],         ],     ], ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "bank_card",         "bank_card_id": 80,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     } } 

Example 3. Create order from draft deliveries. First point cannot be delivery.

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"matter":"Documents","points":[{"address":"R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020","contact_person":{"phone":"5511900000001"}},{"delivery_id":11712,"address":"Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100","contact_person":{"phone":"5511900000001"}}]}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/create-order' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": 11712,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     } } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/create-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'matter' => 'Documents',     'points' => [         [             'address' => 'R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020',             'contact_person' => [                 'phone' => '5511900000001',             ],         ],         [             'delivery_id' => 11712,             'address' => 'Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100',             'contact_person' => [                 'phone' => '5511900000001',             ],         ],     ], ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": 11712,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     } } 

Order editing

This API method can be used to edit an order in statuses: new, available, active or delayed (Order statuses).

• Request parameters
• Response parameters
• Examples

Request parameters

• order_id integer Required

  Full order ID.

To edit the order, send any number of extra parameters from order creation.
If modified value is valid, it will be applied to the order.
If a parameter is not sent with the request, its value will not be changed.
If a parameter is sent with null value, corresponding value will be removed from the order.

When editing a point, always send its ID along with changed values, otherwise a new point will be added to the order. Also, any points with IDs not mentioned in the request will be deleted.

When editing a package, always send its ID along with changed values, otherwise a new package will be added to the point. Also, any packages with IDs not mentioned in the request will be deleted.

See order editing examples to avoid pitfalls.

Response parameters

• is_successful boolean

  Whether the request was successful or not.

• order object

  Modified order data.

  Order parameters

  • order_id integer

    Full order ID.

  • type string

    Order type.

    Order types

  • matter string

    Delivery contents.

  • order_name string

    Order name (short order ID).

  • vehicle_type_id integer

    Vehicle type.

    Vehicle types

  • created_datetime timestamp

    Order creation date and time.

  • finish_datetime timestamp / null

    Order completion date and time.

  • status string

    Order status.

    Order statuses

  • status_description string

    Order status description.

  • total_weight_kg integer

    Total weight in kilograms.

  • is_client_notification_enabled boolean

    Whether to send SMS notifications to the client.

  • is_contact_person_notification_enabled boolean

    Whether to send SMS notifications to recipients on addresses.

  • loaders_count integer

    Number of necessary loaders to move the delivered goods, including the driver.

  • points list

    List of addresses (points) for the courier to visit.

    Point parameters

    • point_id integer

      Point ID.

    • delivery_id integer / null

      Delivery ID.

    • address string

      Street address.

    • contact_person object

      Contact person on the address.

      Contact person parameters

      • phone phone

        Phone number of the person at the address.

      • name string / null

        Name of the person on the address.

    • client_order_id string / null

      Your eshop's order ID. It will be sent in notifications instead of our delivery order ID.

    • latitude coordinate

      Latitude of the location.

    • longitude coordinate

      Longitude of the location.

    • required_start_datetime timestamp / null

      How early the courier may arrive at the address.

    • required_finish_datetime timestamp / null

      How late the courier may arrive at the address.

    • arrival_start_datetime timestamp / null

      Estimated courier arrival time, upper bound.

    • arrival_finish_datetime timestamp / null

      Estimated courier arrival time, lower bound.

    • courier_visit_datetime timestamp / null

      Actual courier arrival time.

    • taking_amount money

      Backpayment sum to receive from the contact person at the address.

    • buyout_amount money

      Buyout sum the courier pays to the contact person at the address.

    • note string / null

      Additional information for the courier: office or appartment number, company name, whether any documents are required to enter the building.

    • packages list

      List of packages at the point.

      Package parameters

      • order_package_id integer

        Package ID.

      • ware_code string

        Vendor code.

      • description string

        Description.

      • items_count float

        Amount.

      • item_payment_amount string

        Price per item.

      • nomenclature_code string

        Nomenclature code.

    • is_cod_cash_voucher_required boolean

      Whether to issue a cashier's check to the recipient at the address.

    • is_order_payment_here boolean

      Money will be paid to the courier at the address.

    • building_number string / null

      Building number.

    • entrance_number string / null

      Entrance number.

    • intercom_code string / null

      Intercom code.

    • floor_number string / null

      Floor number.

    • apartment_number string / null

      Apartment/office number.

    • invisible_mile_navigation_instructions string / null

      Instruction to courier how to get to recipient at the address.

    • place_photo_url string / null

      Place photo when closing a point at the address.

    • sign_photo_url string / null

      Recipients signature photo when closing a point at the address.

    • checkin_code string / null

      Courier's arrival pin code at the point.

    • checkin object / null

      Checkin information when closing a point at the address.

      Checkin parameters

      • recipient_full_name string / null

        Full name of the recipient who met the courier.

      • recipient_position string / null

        Position of the recipient who met the courier.

    • is_return_point boolean

      Return point (same as first or hub).

    • tracking_url string / null

      Recipient's tracking link.

    • delivery object / null

      Delivery.

      Delivery parameters

      • status string

        Delivery status.

  • payment_amount money / null

    Order price.

  • delivery_fee_amount money / null

    Delivery fee.

    Part of order price (payment_amount).

  • weight_fee_amount money / null

    Large weight fee.

    Part of order price (payment_amount).

  • insurance_amount money / null

    Insured amount.

  • insurance_fee_amount money / null

    Insurance fee.

    Part of order price (payment_amount).

  • loading_fee_amount money / null

    Loading / heavy lifting fee.

    Part of order price (payment_amount).

  • money_transfer_fee_amount money / null

    Money handling fee: backpayment transfer, buyout operations.

    Part of order price (payment_amount).

  • cod_fee_amount money / null

    Extra fee for issuing a cashier's check.

    Part of order price (payment_amount).

  • return_fee_amount money / null

    Extra fee for return to first point.

    Part of order price (payment_amount).

  • waiting_fee_amount money / null

    Extra fee for paid waiting at designated points.

    Part of order price (payment_amount).

  • backpayment_details string / null

    Details of the money transfer for backpayment. A credit card number or other payment system information.

  • backpayment_photo_url string / null

    URL of backpayment photo (receipt or other payment verification).

  • itinerary_document_url string / null

    URL of itinerary document.

  • waybill_document_url string / null

    URL of waybill document.

  • courier object / null

    Courier parameters.

    Courier parameters

    • courier_id integer

      Courier ID.

    • surname string

      Surname of the courier.

    • name string

      Name of the courier.

    • middlename string

      Middlename of the courier.

    • phone phone

      Phone of the courier.

    • photo_url string / null

      URL of the courier's photo.

    • latitude coordinate / null

      Latitude of the location.

      Only for active orders, if the courier is on the way.

    • longitude coordinate / null

      Longitude of the location.

      Only for active orders, if the courier is on the way.

  • is_motobox_required boolean

    Is motobox required.

  • is_thermobox_required boolean

    Is thermobox required.

  • payment_method string

    Payment method.

    Payment methods

  • bank_card_id integer / null

    Bank card ID for bank_card payment method.

  • applied_promo_code string / null

    Applied promo code.

  • is_return_required boolean

    Order has return.

  • promo_code_discount_amount money

    Discount amount by promo code.

    Part of order price (payment_amount).

Request example

Example 1. Changing delivery details (matter) and removing backpayment details (backpayment_details).

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"order_id":1250032,"matter":"Flowers","backpayment_details":null}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Flowers",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'order_id'            => 1250032,     'matter'              => 'Flowers',     'backpayment_details' => null, ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Flowers",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false } 

Example 2. Modifying times on a point and adding a new point. First point should be kept as it was.

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"order_id":1250032,"points":[{"point_id":202685},{"point_id":202686,"required_start_datetime":"2024-11-23T11:08:35-03:00","required_finish_datetime":"2024-11-23T11:38:35-03:00"},{"address":"R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020","contact_person":{"phone":"5511900000001"}}]}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Flowers",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }, {             "point_id": 202687,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T12:08:35-03:00",             "required_finish_datetime": "2024-11-23T12:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'order_id' => 1250032,     'points'   => [         [             'point_id' => 202685,         ],         [             'point_id'                 => 202686,             'required_start_datetime'  => '2024-11-23T11:08:35-03:00',             'required_finish_datetime' => '2024-11-23T11:38:35-03:00',         ],         [             'address' => 'R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020',             'contact_person' => [                 'phone' => '5511900000001',             ],         ],     ], ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Flowers",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }, {             "point_id": 202687,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T12:08:35-03:00",             "required_finish_datetime": "2024-11-23T12:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false } 

Example 3. Removing third point from the order.

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"order_id":1250032,"points":[{"point_id":202685},{"point_id":202686}]}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Flowers",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'order_id' => 1250032,     'points'   => [         [             'point_id' => 202685,         ],         [             'point_id' => 202686,         ],     ], ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Flowers",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false } 

Example 4. Modifying attributes of a package on second point, remove package on third point, and keep package on first point.

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"order_id":1250032,"points":[{"point_id":202685, "packages": [{"order_package_id": 3632252}]},{"point_id":202686, "packages": [{"order_package_id": 3632253, "items_count": 3}]},{"point_id": 202687}]}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Flowers",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [{                 "order_package_id": 3632252,                 "ware_code": "140012",                 "description": "Guarda-chuva",                 "items_count": 1,                 "item_payment_amount": 35.00             }],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [{                 "order_package_id": 3632253,                 "ware_code": "100112",                 "description": "Chapéu",                 "items_count": 3,                 "item_payment_amount": 118.00             }],             "is_cod_cash_voucher_required": true,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }, {             "point_id": 202687,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T12:08:35-03:00",             "required_finish_datetime": "2024-11-23T12:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "7.65",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'order_id' => 1250032,     'points'   => [         [             'point_id' => 202685,             'packages' => [                 [                     'order_package_id' => 3632252,                 ]             ],         ],         [             'point_id' => 202686,             'packages' => [                 [                     'order_package_id' => 3632253,                     'items_count'      => 3,                 ]             ],         ],         [            'point_id' => 202687,         ],     ], ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Flowers",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [{                 "order_package_id": 3632252,                 "ware_code": "140012",                 "description": "Guarda-chuva",                 "items_count": 1,                 "item_payment_amount": 35.00             }],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [{                 "order_package_id": 3632253,                 "ware_code": "100112",                 "description": "Chapéu",                 "items_count": 3,                 "item_payment_amount": 118.00             }],             "is_cod_cash_voucher_required": true,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }, {             "point_id": 202687,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T12:08:35-03:00",             "required_finish_datetime": "2024-11-23T12:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "7.65",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false } 

Example 5. Setting COD payment attributes. Set the voucher requirement and COD payment amount received at the second point, and remove COD payment and voucher requirement for the third point.

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"order_id":1250032,"points":[{"point_id":202685},{"point_id":202686, "is_cod_cash_voucher_required": true, "taking_amount": 118.00},{"point_id": 202687, "is_cod_cash_voucher_required": false, "taking_amount": 0.00}]}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order' 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/edit-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'order_id' => 1250032,     'points'   => [         [             'point_id' => 202685,         ],         [             'point_id'                     => 202686,             'is_cod_cash_voucher_required' => true,             'taking_amount'                => 118.00,         ],         [            'point_id'                     => 202687,            'is_cod_cash_voucher_required' => false,            'taking_amount'                => 0.00,         ],     ], ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "available",         "status_description": "available",         "matter": "Flowers",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "118.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": true,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }, {             "point_id": 202687,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T12:08:35-03:00",             "required_finish_datetime": "2024-11-23T12:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "7.65",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null     } } 

Canceling an order

You may cancel an order in statuses: new, available, active or delayed (Order statuses). If a courier has visited any addresses, the order cannot be canceled.

• Request parameters
• Response parameters
• Examples

Request parameters

• order_id integer Required

  Full order ID to cancel.

Response parameters

• is_successful boolean

  Whether the request was successful or not.

• order object

  Canceled order data.

  Order parameters

  • order_id integer

    Full order ID.

  • type string

    Order type.

    Order types

  • matter string

    Delivery contents.

  • order_name string

    Order name (short order ID).

  • vehicle_type_id integer

    Vehicle type.

    Vehicle types

  • created_datetime timestamp

    Order creation date and time.

  • finish_datetime timestamp / null

    Order completion date and time.

  • status string

    Order status.

    Order statuses

  • status_description string

    Order status description.

  • total_weight_kg integer

    Total weight in kilograms.

  • is_client_notification_enabled boolean

    Whether to send SMS notifications to the client.

  • is_contact_person_notification_enabled boolean

    Whether to send SMS notifications to recipients on addresses.

  • loaders_count integer

    Number of necessary loaders to move the delivered goods, including the driver.

  • points list

    List of addresses (points) for the courier to visit.

    Point parameters

    • point_id integer

      Point ID.

    • delivery_id integer / null

      Delivery ID.

    • address string

      Street address.

    • contact_person object

      Contact person on the address.

      Contact person parameters

      • phone phone

        Phone number of the person at the address.

      • name string / null

        Name of the person on the address.

    • client_order_id string / null

      Your eshop's order ID. It will be sent in notifications instead of our delivery order ID.

    • latitude coordinate

      Latitude of the location.

    • longitude coordinate

      Longitude of the location.

    • required_start_datetime timestamp / null

      How early the courier may arrive at the address.

    • required_finish_datetime timestamp / null

      How late the courier may arrive at the address.

    • arrival_start_datetime timestamp / null

      Estimated courier arrival time, upper bound.

    • arrival_finish_datetime timestamp / null

      Estimated courier arrival time, lower bound.

    • courier_visit_datetime timestamp / null

      Actual courier arrival time.

    • taking_amount money

      Backpayment sum to receive from the contact person at the address.

    • buyout_amount money

      Buyout sum the courier pays to the contact person at the address.

    • note string / null

      Additional information for the courier: office or appartment number, company name, whether any documents are required to enter the building.

    • packages list

      List of packages at the point.

      Package parameters

      • order_package_id integer

        Package ID.

      • ware_code string

        Vendor code.

      • description string

        Description.

      • items_count float

        Amount.

      • item_payment_amount string

        Price per item.

      • nomenclature_code string

        Nomenclature code.

    • is_cod_cash_voucher_required boolean

      Whether to issue a cashier's check to the recipient at the address.

    • is_order_payment_here boolean

      Money will be paid to the courier at the address.

    • building_number string / null

      Building number.

    • entrance_number string / null

      Entrance number.

    • intercom_code string / null

      Intercom code.

    • floor_number string / null

      Floor number.

    • apartment_number string / null

      Apartment/office number.

    • invisible_mile_navigation_instructions string / null

      Instruction to courier how to get to recipient at the address.

    • place_photo_url string / null

      Place photo when closing a point at the address.

    • sign_photo_url string / null

      Recipients signature photo when closing a point at the address.

    • checkin_code string / null

      Courier's arrival pin code at the point.

    • checkin object / null

      Checkin information when closing a point at the address.

      Checkin parameters

      • recipient_full_name string / null

        Full name of the recipient who met the courier.

      • recipient_position string / null

        Position of the recipient who met the courier.

    • is_return_point boolean

      Return point (same as first or hub).

    • tracking_url string / null

      Recipient's tracking link.

    • delivery object / null

      Delivery.

      Delivery parameters

      • status string

        Delivery status.

  • payment_amount money / null

    Order price.

  • delivery_fee_amount money / null

    Delivery fee.

    Part of order price (payment_amount).

  • weight_fee_amount money / null

    Large weight fee.

    Part of order price (payment_amount).

  • insurance_amount money / null

    Insured amount.

  • insurance_fee_amount money / null

    Insurance fee.

    Part of order price (payment_amount).

  • loading_fee_amount money / null

    Loading / heavy lifting fee.

    Part of order price (payment_amount).

  • money_transfer_fee_amount money / null

    Money handling fee: backpayment transfer, buyout operations.

    Part of order price (payment_amount).

  • cod_fee_amount money / null

    Extra fee for issuing a cashier's check.

    Part of order price (payment_amount).

  • return_fee_amount money / null

    Extra fee for return to first point.

    Part of order price (payment_amount).

  • waiting_fee_amount money / null

    Extra fee for paid waiting at designated points.

    Part of order price (payment_amount).

  • backpayment_details string / null

    Details of the money transfer for backpayment. A credit card number or other payment system information.

  • backpayment_photo_url string / null

    URL of backpayment photo (receipt or other payment verification).

  • itinerary_document_url string / null

    URL of itinerary document.

  • waybill_document_url string / null

    URL of waybill document.

  • courier object / null

    Courier parameters.

    Courier parameters

    • courier_id integer

      Courier ID.

    • surname string

      Surname of the courier.

    • name string

      Name of the courier.

    • middlename string

      Middlename of the courier.

    • phone phone

      Phone of the courier.

    • photo_url string / null

      URL of the courier's photo.

    • latitude coordinate / null

      Latitude of the location.

      Only for active orders, if the courier is on the way.

    • longitude coordinate / null

      Longitude of the location.

      Only for active orders, if the courier is on the way.

  • is_motobox_required boolean

    Is motobox required.

  • is_thermobox_required boolean

    Is thermobox required.

  • payment_method string

    Payment method.

    Payment methods

  • bank_card_id integer / null

    Bank card ID for bank_card payment method.

  • applied_promo_code string / null

    Applied promo code.

  • is_return_required boolean

    Order has return.

  • promo_code_discount_amount money

    Discount amount by promo code.

    Part of order price (payment_amount).

Request example

CURL

curl --include --header 'X-DV-Auth-Token: SECRET_AUTH_TOKEN' --data '{"order_id":1250032}' 'https://robotapitest-br.borzodelivery.com/api/business/1.6/cancel-order' 

HTTP/1.1 200 OK Date: Sat, 23 Nov 2024 12:38:35 GMT Content-Type: application/json; charset=utf-8  {     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "canceled",         "status_description": "O cliente não está respondendo",         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     } } 

PHP

<?php  $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, 'https://robotapitest-br.borzodelivery.com/api/business/1.6/cancel-order'); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($curl, CURLOPT_HTTPHEADER, ['X-DV-Auth-Token: SECRET_AUTH_TOKEN']); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);  $data = [     'order_id' => 1250032, ];  $json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); curl_setopt($curl, CURLOPT_POSTFIELDS, $json);  $result = curl_exec($curl); if ($result === false) {     throw new Exception(curl_error($curl), curl_errno($curl)); }  echo $result; 

{     "is_successful": true,     "order": {         "type": "standard",         "order_id": 1250032,         "order_name": "50032",         "vehicle_type_id": 8,         "created_datetime": "2024-11-23T09:38:35-03:00",         "finish_datetime": null,         "status": "canceled",         "status_description": "O cliente não está respondendo",         "matter": "Documents",         "total_weight_kg": 0,         "is_client_notification_enabled": false,         "is_contact_person_notification_enabled": false,         "loaders_count": 0,         "backpayment_details": null,         "points": [{             "point_id": 202685,             "delivery_id": null,             "client_order_id": null,             "address": "R. Guamiranga, 1140 - Vila Independencia, São Paulo - SP, 04220-020",             "latitude": "-23.5962988",             "longitude": "-46.5858049",             "required_start_datetime": "2024-11-23T10:08:35-03:00",             "required_finish_datetime": "2024-11-23T10:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": null         }, {             "point_id": 202686,             "delivery_id": null,             "client_order_id": null,             "address": "Av. Paulista, 1439 - 12 - Bela Vista, São Paulo - SP, 01310-100",             "latitude": "-23.562747",             "longitude": "-46.6576753",             "required_start_datetime": "2024-11-23T11:08:35-03:00",             "required_finish_datetime": "2024-11-23T11:38:35-03:00",             "arrival_start_datetime": null,             "arrival_finish_datetime": null,             "estimated_arrival_datetime": null,             "courier_visit_datetime": null,             "contact_person": {                 "name": null,                 "phone": "5511900000001"             },             "taking_amount": "0.00",             "buyout_amount": "0.00",             "note": null,             "packages": [],             "is_cod_cash_voucher_required": false,             "is_order_payment_here": false,             "building_number": null,             "entrance_number": null,             "intercom_code": null,             "floor_number": null,             "apartment_number": null,             "invisible_mile_navigation_instructions": null,             "place_photo_url": null,             "sign_photo_url": null,             "checkin_code": null,             "checkin": null,             "is_return_point": false,             "tracking_url": null,             "delivery": {                 "status": "planned"             }         }],         "payment_amount": "18.00",         "delivery_fee_amount": "18.00",         "weight_fee_amount": "0.00",         "insurance_amount": "0.00",         "insurance_fee_amount": "0.00",         "loading_fee_amount": "0.00",         "money_transfer_fee_amount": "0.00",         "promo_code_discount_amount": "5.00",         "backpayment_amount": "0.00",         "cod_fee_amount": "0.00",         "return_fee_amount": "0.00",         "waiting_fee_amount": "0.00",         "backpayment_photo_url": null,         "itinerary_document_url": null,         "waybill_document_url": null,         "courier": null,         "is_motobox_required": false,         "payment_method": "cash",         "bank_card_id": null,         "applied_promo_code": "FIRST_ORDER",         "is_return_required": false     } } 

List of orders

Use this API method to retrieve a list of your orders. The list is sorted by order_id, descending.

• Request parameters
• Response parameters
• Examples

Request parameters

• order_id integer / list

  Full order ID or order IDs list to search for.

  Default value: null.

• status string

  Order statuses to search for.

  Default value: null.

  Order statuses

• offset integer

  Number of orders to skip for paginaton.

  Default value: 0.

• count integer

  Maximum number of orders to be returned. Cannot be higher than 50.

  Default value: 10.

Response parameters

• is_successful boolean

  Whether the request was successful or not.

• orders list

  List of orders.

  Order parameters

  • order_id integer

    Full order ID.

  • type string

    Order type.

    Order types

  • matter string

    Delivery contents.

  • order_name string

    Order name (short order ID).

  • vehicle_type_id integer

    Vehicle type.

    Vehicle types

  • created_datetime timestamp

    Order creation date and time.

  • finish_datetime timestamp / null

    Order completion date and time.

  • status string

    Order status.

    Order statuses

  • status_description string

    Order status description.

  • total_weight_kg integer

    Total weight in kilograms.

  • is_client_notification_enabled boolean

    Whether to send SMS notifications to the client.

  • is_contact_person_notification_enabled boolean

    Whether to send SMS notifications to recipients on addresses.

  • loaders_count integer

    Number of necessary loaders to move the delivered goods, including the driver.

  • points list

    List of addresses (points) for the courier to visit.

    Point parameters

    • point_id integer

      Point ID.

    • delivery_id integer / null

      Delivery ID.

    • address string

      Street address.

    • contact_person object

      Contact person on the address.

      Contact person parameters

      • phone phone

        Phone number of the person at the address.

      • name string / null

        Name of the person on the address.

    • client_order_id string / null

      Your eshop's order ID. It will be sent in notifications instead of our delivery order ID.

    • latitude coordinate

      Latitude of the location.

    • longitude coordinate

      Longitude of the location.

    • required_start_datetime timestamp / null

      How early the courier may arrive at the address.

    • required_finish_datetime timestamp / null

      How late the courier may arrive at the address.

    • arrival_start_datetime timestamp / null

      Estimated courier arrival time, upper bound.

    • arrival_finish_datetime timestamp / null

      Estimated courier arrival time, lower bound.

    • courier_visit_datetime timestamp / null

      Actual courier arrival time.

    • taking_amount money

      Backpayment sum to receive from the contact person at the address.

    • buyout_amount money

      Buyout sum the courier pays to the contact person at the address.

    • note string / null

      Additional information for the courier: office or appartment number, company name, whether any documents are required to enter the building.

    • packages list

      List of packages at the point.

      Package parameters

      • order_package_id integer

        Package ID.

      • ware_code string

        Vendor code.

      • description string

        Description.

      • items_count float

        Amount.

      • item_payment_amount string

        Price per item.

      • nomenclature_code string

        Nomenclature code.

    • is_cod_cash_voucher_required boolean

      Whether to issue a cashier's check to the recipient at the address.

    • is_order_payment_here boolean

      Money will be paid to the courier at the address.

    • building_number string / null

      Building number.

    • entrance_number string / null

      Entrance number.

    • intercom_code string / null

      Intercom code.

    • floor_number string / null

      Floor number.

    • apartment_number string / null

      Apartment/office number.

    • invisible_mile_navigation_instructions string / null

      Instruction to courier how to get to recipient at the address.

    • place_photo_url string / null

      Place photo when closing a point at the address.

    • sign_photo_url string / null

      Recipients signature photo when closing a point at the address.

    • checkin_code string / null

      Courier's arrival pin code at the point.

    • checkin object / null

      Checkin information when closing a point at the address.

      Checkin parameters

      • recipient_full_name string / null

        Full name of the recipient who met the courier.

      • recipient_position string / null

        Position of the recipient who met the courier.

    • is_return_point boolean

      Return point (same as first or hub).

    • tracking_url string / null

      Recipient's tracking link.

    • delivery object / null

      Delivery.

      Delivery parameters

      • status string

        Delivery status.

  • payment_amount money / null

    Order price.

  • delivery_fee_amount money / null

    Delivery fee.

    Part of order price (payment_amount).

  • weight_fee_amount money / null

    Large weight fee.

    Part of order price (payment_amount).

  • insurance_amount money / null

    Insured amount.

  • insurance_fee_amount money / null

    Insurance fee.

    Part of order price (payment_amount).

  • loading_fee_amount money / null

    Loading / heavy lifting fee.

    Part of order price (payment_amount).

  • money_transfer_fee_amount money / null

    Money handling fee: backpayment transfer, buyout operations.

    Part of order price (payment_amount).

  • cod_fee_amount money / null

    Extra fee for issuing a cashier's check.

    Part of order price (payment_amount).

  • return_fee_amount money / null

    Extra fee for return to first point.

    Part of order price (payment_amount).

  • waiting_fee_amount money / null

    Extra fee for paid waiting at designated points.

    Part of order price (payment_amount).

  • backpayment_details string / null

    Details of the money transfer for backpayment. A credit card number or other payment system information.

  • backpayment_photo_url string / null

    URL of backpayment photo (receipt or other payment verification).

  • itinerary_document_url string / null

    URL of itinerary document.

  • waybill_document_url string / null

    URL of waybill document.

  • courier object / null

    Courier parameters.

    Courier parameters

    • courier_id integer

      Courier ID.

    • surname string

      Surname of the courier.

    • name string

      Name of the courier.

    • middlename string

      Middlename of the courier.

    • phone phone

      Phone of the courier.

    • photo_url string / null

      URL of the courier's photo.

    • latitude coordinate / null

      Latitude of the location.

      Only for active orders, if the courier is on the way.

    • longitude coordinate / null

      Longitude of the location.

      Only for active orders, if the courier is on the way.

  • is_motobox_required boolean

    Is motobox required.

  • is_thermobox_required boolean

    Is thermobox required.

  • payment_method string

    Payment method.

    Payment methods

  • bank_card_id integer / null

    Bank card ID for bank_card payment method.

  • applied_promo_code string / null

    Applied promo code.

  • is_return_required boolean

    Order has return.

  • promo_code_discount_amount money

    Discount amount by promo code.

    Part of order price (payment_amount).

• orders_count integer

  Total number of found orders for pagination.