npm package: @one-view/pd-oneview-delivery-panel-types
Description: backend for oneview delivery panel plugin
Latest version: 0.0.31


FORMAT: 1A
VERSION: 1.0.0
HOST: https://api.pd-oneview.net/delivery-panel

# pd-oneview-delivery-panel

backend for oneview delivery panel plugin




## Delivery Detail [/v1/{orderCode}/detail{?GID,order.noCache}]

Delivery detail information

+ Parameters
    + orderCode (required, string, `vsba-nhas`)
    + GID (string, optional) - global entity id
        + Default: `FP_SG`
    + order.noCache (boolean, optional, `false`) - use cache or not when calling GCC order endpoint

+ Attributes (Delivery)

### Get delivery detail [GET]

+ Request

    + Headers

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

+ Response 200 (application/json)
    + Attributes (Delivery)

+ 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)

## Drop off Address [/v1/{orderCode}/dropoff-address{?GID}]

Drop off address management

+ Parameters
    + orderCode (required, string, `vsba-nhas`)
    + GID (string, optional) - global entity id
        + Default: `FP_SG`

### change delivery address [POST]

+ Request

    + Headers

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

+ Attributes (Address)

+ Response 202 (application/json)

+ Response 400 (application/json)
    + Attributes (Error_400)

+ Response 401 (application/json)
    + Attributes (Error_401)

+ Response 403 (application/json)
    + Attributes (Error_403)

+ Response 404 (application/json)
    + Attributes (Error_404)

+ Response 409 (application/json)
    + Attributes (Error_409)

+ Response 429 (application/json)
    + Attributes (Error_429)

+ Response 500 (application/json)
    + Attributes (Error_500)

## Rider Chat Transcript [/v1/{orderCode}/rider-chat{?geid,noCache}]

Rider chat transcript

+ Parameters
    + orderCode (required, string, `vsba-nhas`)
    + geid (required, string, `FP_SG`) - global entity id
    + noCache (boolean, optional, `false`) - use cache or not when calling GCC order endpoint

### rider chat transcript [GET]

+ Request

    + Headers

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

+ Response 200 (application/json)
    + Attributes (RiderChatTranscriptResponse)

+ 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)

## Drop off Instruction [/v2/orders/{orderCode}/dropoff-instruction{?GID}]

Drop off instruction management

+ Parameters
    + orderCode (required, string, `vsba-nhas`)
    + GID (string, optional) - global entity id
        + Default: `FP_SG`

### change delivery instruction [POST]

+ Request

    + Headers

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

+ Attributes (InstructionMessage)

+ Response 202 (application/json)

+ Response 400 (application/json)
    + Attributes (Error_400)

+ Response 401 (application/json)
    + Attributes (Error_401)

+ Response 403 (application/json)
    + Attributes (Error_403)

+ Response 404 (application/json)
    + Attributes (Error_404)

+ Response 409 (application/json)
    + Attributes (Error_409)

+ Response 429 (application/json)
    + Attributes (Error_429)

+ Response 500 (application/json)
    + Attributes (Error_500)

## Address autocomplete [/v2/addresses/autocomplete{?GID,query,country,language,latitude,longitude,radius,types}]

Address autocomplete function

+ Parameters
    + GID (string, required) - global entity id
    + query (string, required) - query for address autocomplete
    + types (string, optional) - address types
    + country (string, optional) - country to query on
    + language (string, optional) - language for address
    + latitude (number, optional) - latitude point to start the radius
    + longitude (number, optional) - longitude point to start the radius
    + radius (int64, optional) - size of the radius

### get formatted address [GET]

+ Request

    + Headers

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

+ Response 200 (application/json)
    + Attributes (AutoCompleteResponse)

+ Response 400 (application/json)
    + Attributes (Error_400)

+ Response 500 (application/json)
    + Attributes (Error_500)

## Address details [/v2/addresses/detail/{addressId}{?GID,language}]

Endpoint detailing address from address code (ID)

+ Parameters
    + GID (string, required) - global entity id
    + addressId (string, required) - address ID from autocomplete endpoint
    + language (string, optional) - language for address

### get address detail [GET]

+ Request

    + Headers

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

+ Response 200 (application/json)
    + Attributes (AddressDetail)

+ Response 400 (application/json)
    + Attributes (Error_400)

+ Response 500 (application/json)
    + Attributes (Error_500)

# Data Structures

## int32 (number)
## int64 (number)

## Address
+ addressText (string)
+ street (string)
+ city (string)
+ postalCode (string)
+ company (string, optional)
+ number (string, optional)
+ block (string, optional)
+ building (string, optional)
+ apartment (string, optional)
+ entrance (string, optional)
+ intercom (string, optional)
+ floor (string, optional)
+ suburb (string, optional)
+ latitude (number, required)
+ longitude (number, required)
+ formatted_address (string, optional)
+ instruction (string, optional)

## Contact
+ name    : `Tian Tian Chi Mian` (string) - contact name
+ address (Address) - contact address
+ phone (string) - contact voice call number
+ sms (string) - contact sms number
+ email (string) - contact email

## `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_409` (object)
+ errors (array)
    + error_object
        + `status`: `409` (string)
        + `title`: `Another modification is currently ongoing, please retry later (concurrent-modification)` (string)

## `Error_429` (object)
+ errors (array)
    + error_object
        + `status`: `429` (string)
        + `title`: `There are ongoing concurrent requests of this order, please retry later (order-change-concurrent)` (string)

## `Error_500` (object)
+ errors (array)
    + error_object
        + `status`: `500` (string)
        + `title`: `internal server error` (string)

## Delivery
+ orderCode             : `vsba-nhas` (string, required) - order code
+ orderNumber           : 3 (int32) - vendor order number
+ vendor                (Contact) - vendor info
+ customer              (Contact) - customer info
+ platform              : `Foodpanda` (string) - platform name
+ statusTime            : 1572499999 (int64) - epoch time stamp of latest status
+ status                : `In Progress (since 11:30 AM)` (string) - order status
+ promisedTimestamp     : 1572499999 (int64) - epoch time stamp of promised delivery
+ deliveryAgentName     : `hemant` (string) - delivery agent name

## AddressDetail
+ id                : `ChIJzVpCsdFRqEcRuaq1ThB6ENM` (string, required) - address ID
+ formattedAddress  : `79 C Mauerstraße, 10117 Berlin` (string) - formatted address for display
+ building          : `79 C` (string) - building name
+ street            : `Mauerstraße` (string) - street name
+ number            : `79 C` (string) - street number
+ zipcode           : `10117` (string) - zipcode
+ latitude          : 52.5093007 (number) - latitude point of the address
+ longitude         : 13.3880902 (number) - longitude point of the address
+ city              : `Berlin` (string) - city name
+ country           : `German` (string) - country name
+ countryCode       : `DE` (string) - country code
+ area              : `Mitte` (string) - area name
+ suburb            : `Mitte` (string) - suburb name

## AutoCompleteResponse
+ list (array[AddressDetail], fixed-type, required)

## InstructionMessage
+ instructions : `example message` (string, required) - drop off instruction message

## RiderChatSender (enum)
+ `customer`
+ `rider`

## RiderChatTranslations (object)

## RiderChatTranscript
+ timestamp : 1572499999 (int64, required) - message timestamp
+ sender    (RiderChatSender, required) - message sender
+ content   : `some-message` (string, required) - message content
+ translations (RiderChatTranslations, optional) - translations (if available)

## RiderChatTranscriptResponse
+ transcript        (array[RiderChatTranscript], fixed-type, optional)
+ chatCreatedAt     : 1572499999 (int64, optional) - chat created at timestamp
+ riderJoinedAt     : 1572499999 (int64, optional) - rider joined chat timestamp
+ customerJoinedAt  : 1572499999 (int64, optional) - customer joined chat timestamp
+ originalLanguage  : `en` (string, optional) - original language chat is in
+ supportedLanguage : `ms` (array[string], fixed-type, optional) - languages that translation is supported in