Delivery

Create delivery orders

post/api/v1/Delivery/Orders

Request

  • Base URL: https://api.payex.io
  • URL: https://api.payex.io/api/v1/Delivery/Orders
  • Auth: HTTP bearer

Request body

sender_namestring
sender_contact_nostring
sender_emailstring email
sender_addressstring
sender_postcodestring
sender_location_idinteger

Can be retrieved through the /api/v1/Delivery/Locations/{postcode} endpoint

sender_locationstring

Can be retrieved through the /api/v1/Delivery/Locations/{postcode} endpoint

sender_citystring
sender_statestring
sender_countrystring
delivery_type'p' | 'd'

p - pickup, d - drop-off

pickup_datestring date
pickup_timestring
transportation'v' | 'c' | 'm' | 't'

v - van, c - car, m - motorbike, t - truck

trolleyboolean
remarksstring
service_provider'jnt' | 'gdx' | 'njv' | 'ezp' | 'lmv' | 'mrs'

'provider' parameter of service returned from /api/v1/Delivery/Rates endpoint response. jnt - J&T, gdx - GDex, njv - NinjaVan, ezp - EasyParcel, lmv - Lalamove, mrs - MrSpeedy

Example request

{
  "sender_state": "kul",
  "sender_country": "MY",
  "consignments": [
    {
      "receiver_state": "kul",
      "receiver_country": "MY",
      "pieces": 1,
      "value": 10,
      "weight": 1,
      "price": 1
    }
  ]
}

Response

Success

status'00' | '99'
messagestring

Example response

{
  "result": {
    "total": 5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.