@one-view/pd-oneview-summary-panel-types

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

pd-oneview-summary-panel

backend api for oneview summary panel plugin

Summary Detail [/v1/{orderCode}/detail{?GID,nocache}]

Summary detail information

• Parameters

  • orderCode (required, string, vsba-nhas)
  • GID: FP_SG (string, optional) - global entity id
    • Default: FP_SG
  • nocache: true (boolean, optional) - bypass cache system

• Attributes (Summary)

Get summary detail [GET]

• Request

  • Headers

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

• Response 200 (application/json)

  • Attributes (Summary)

• 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

int8 (number)

int64 (number)

Address

• street (string)
• city (string)
• postalCode (string)

CustomerFraud

• result : true (boolean, required) - customer fraud status
• errorMessage : some error (string) - will return empty string if check is success

Contact

• firstName : Johnny (string)
• lastName : English (string)
• phone (string) - contact voice call number
• sms (string) - contact sms number
• email (string) - contact email
• fraudCheck (CustomerFraud)

Payment

• paymentMethod : cod, credit-card, online-payment (string) - payment method used
• paid : true (boolean)
• amount (number)
• vouchers (array[Voucher], fixed-type)

Voucher

• code : vmdMlZ8 (string) - voucher code
• name : happy new year (string) - voucher name
• description : for user activation (string) - voucher description
• expiry : 2020-10-15T02:10:15+00:00 (string) - timestamp formatted date
• minimumOrder : $10.00 (string) minimum order amount
• value : $20.00 (string) voucher value
• status (VoucherStatus)
• attributes (array[VoucherAttribute], fixed-type)

VoucherStatus (enum)

• APPLICABLE
• NOT_APPLICABLE
• EXPIRED
• USED

VoucherAttribute

• label : code (string, required) - voucher label
• value (object) - actual voucher value
• displayValue : vmdMlZ8 (string, required) - voucher value
• isRestricted : true (boolean, required) - is the value restricted to be copied

Subscription

• code : free (string) - subscription code
• expiry : 1572499999 (int64) - epoch time stamp of expiry date

PhoneNumber

• countryCode (int8)
• areaCode (int8)
• number (string)
• isVerified (boolean)

Error (object)

• errorCode : 401 (int64)
• errorMessage : not authorize (string)

Error_401 (object)

• errorCode : 401 (int64)
• errorMessage : not authorize (string)

Error_404 (object)

• errorCode : 404 (int64)
• errorMessage : not found (string)

Error_403 (object)

• errorCode : 403 (int64)
• errorMessage : forbidden (string)

Error_400 (object)

• errorCode : 400 (int64)
• errorMessage : bad request (string)

Error_500 (object)

• errorCode : 500 (int64)
• errorMessage : internal server error (string)

Summary

• code : vsba-nhas (string, required) - order code
• customerContact (Contact) - customer contact information
• GID : foodpanda singapore (string) - global entity id
• payment (Payment) - payment used for order
• subscription (Subscription)
• status : ACCEPTED (string) - order status
• estimatedTimestamp : 1572499999 (int64) - epoch time stamp of estimated delivery
• promisedTimestamp : 1572499999 (int64) - epoch time stamp of promised delivery
• cancelledReason : some_reason (string, optional) - Cancelled Reason (only present when status is CANCELLED)