npm package: @one-view/order-detail-types
Description: oneview backend order API
Latest version: 1.0.20


FORMAT: 1A
VERSION: 1.0.0

# Order Detail

oneview backend order API




## Order Detail [/order-detail/v1/{orderCode}/detail]

Order detail information

+ Parameters
    + orderCode (required, string, `vsba-nhas`)

+ Attributes (OrderDetail)

### Get order detail [GET]
+ Request

    + Headers

            Authorization: bearer token

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

+ 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 500 (application/json)
    + Attributes (Error_500)

## Order Receipt [/order-detail/v1/{orderCode}/receipt]

+ Parameters
    + orderCode (required, string, `vsba-nhas`)

+ Attributes (OrderReceipt)

### Get order receipt [GET]
+ Request

    + Headers

            Authorization: bearer token

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

+ 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 500 (application/json)
    + Attributes (Error_500)

## Order Status [/order-detail/v1/{order_code}/status]

list the order status of a current order

+ Parameters
    + order_code (required, string, `vsba-nhas`)

+ Attributes (OrderStatusList)

### Get order status [GET]
+ Request

    + Headers

            Authorization: bearer token

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

+ 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 500 (application/json)
    + Attributes (Error_500)
# Data Structures

## int64 (number)

## integer (number)

## float (number)

## date (string)

## `Error` (object)
+ errorCode (number)
+ errorMessage (string)

## `Error_401` (object)
+ errorCode : 401 (number)
+ errorMessage : `not authorize` (string)

## `Error_404` (object)
+ errorCode : 404 (number)
+ errorMessage : `not found` (string)

## `Error_403` (object)
+ errorCode : 403 (number)
+ errorMessage : `forbidden` (string)

## `Error_400` (object)
+ errorCode : 400 (number)
+ errorMessage : `bad request` (string)

## `Error_500` (object)
+ errorCode : 500 (number)
+ errorMessage : `internal server error` (string)

## Payment
+ mode      : `cod, credit-card, online-payment` (string)
+ paid      : true (boolean)
+ amount    (number)
+ vouchers  (array[Voucher])

## Voucher
+ code          (string) - voucher code
+ description   (string)

## OrderStatus
+ timestamp          : 1572499999 (int64) - epoch time stamp of status
+ status             : ACCEPTED (string) - order status
+ estimatedTimestamp : 1572499999 (int64) - epoch time stamp of estimated timestamp
+ reason             (string) - Additional data for status reason
+ comment            (string) - Additional comment for status reason

## Comment
+ data : (string)

## OrderReceiptItem
+ id            (string) - product id
+ name          (string) - product name
+ variantTitle  (string) - variation title of product
+ basePrice     (number) - product base price
+ toppingPrice  (number) - topping price
+ quantity      (int64) - quantity of product

## OrderReceiptData
+ description   : "Sub Total" (string) - description of receipt meta data
+ amount        : 3.42 (number) - amount tied to it

## OrderDetail
+ code                  : `vsba-nhas` (string, required) - order code
+ vendorCode            : `vsba` (string) - vendor code. usually used to get vendor detail information
+ customerCode          : `asd2sas` (string) - Customer code. usually used to get constumer detail information
+ platform              : `Android-foodpanda-5.9.0(258704)` (string) - platform used for order
+ source                : `android` (string) - device source of order. exp : android
+ invoiceURL            : `http://unknown` (string) - url to generate the invoice
+ cookingInstruction    : `do something` (string)
+ orderTimestamp        : 1572493929 (int64) - epoch timestamp of order
+ preorderTimestamp     : 1572493929 (int64) - epoch timestamp of the preorder time
+ promisedTimestamp     : 1572493929 (int64) - epoch timestamp of the promised delivery time
+ deliveryProvider      : RPS (string) - delivery provider. e.g: RPS
+ comments              (array[Comment]) - comment of order
+ internalComments      (array[Comment]) - internal comment of order
+ vendorOrderReference  (string)
+ expeditionType        (string) - expedition type used for order. exp : pickup, delivery, etc.
+ payment               (Payment) - payment used for order
+ lastStatus            (OrderStatus) - last known status of order
+ canceled              (string) - Valid string containing reason if order is canceled. Null otherwise.
+ refundStatus          : NONE (string) - Refund status. NONE, PENDING, REFUNDED

## OrderReceipt
+ items (array[OrderReceiptItem]) - List of order item
+ data  (array[OrderReceiptData]) - arbitrary receipt data. could refer to order payment flow.

## OrderStatusList
+ data (array[OrderStatus]) - List of order status