@one-view/pd-oneview-courier-location-types

FORMAT: 1A VERSION: 1.0.0 HOST: https://api.pd-oneview.net/courier-location

pd-oneview-courier-location

backend for oneview pd-oneview-courier-location-view plugin

Delivery Locations [/v1/{orderCode}/locations{?gid}]

Delivery location information

• Parameters

  • orderCode (required, string, vsba-nhas)
  • gid (string, optional) - global entity id
    • Default: FP_SG

• Attributes (DeliveryLocations)

Get Delivery Locations Information [GET]

• Request

  • Headers

      Authorization: bearer token
      X-Contact-Id: case-id
    

• Response 200 (application/json)

  • Attributes (DeliveryLocations)

• Response 400 (application/json)

  • Attributes (Error_400)

• Response 403 (application/json)

  • Attributes (Error_403)

• Response 404 (application/json)

  • Attributes (Error_404)

• Response 500 (application/json)

  • Attributes (Error_500)

Data Structures

int32 (number)

int64 (number)

error_object (object)

• status (string) - HTTP status code for this problem, expressed as a string value
• title (string) - short, human-readable unique summary of the problem (not localized)

Error (object)

• errors (array[error_object])

Error_401 (object)

• errors (array)
  • error_object
    • status: 401 (string)
    • title: not authorize (string)

Error_404 (object)

• errors (array)
  • error_object
    • status: 404 (string)
    • title: not found (string)

Error_403 (object)

• errors (array)
  • error_object
    • status: 403 (string)
    • title: forbidden (string)

Error_400 (object)

• errors (array)
  • error_object
    • status: 400 (string)
    • title: bad request (string)

Error_500 (object)

• errors (array)
  • error_object
    • status: 500 (string)
    • title: internal server error (string)

Location

• latitude : 70.4 (number, required) - location latitude
• longitude : 10.312 (number, required) - location longitude
• label : pickup (string) - location label. might contains timestamp or location event name

DeliveryLocations

• pickup (Location, required) - order pickup location
• dropOff (Location, required) - order drop off location
• courierLocations (array[Location]) - courier locations