oneview backend order API
npm install @one-view/pd-oneview-order-detail-types
FORMAT: 1A
VERSION: 1.0.0
HOST: https://api.pd-oneview.net/order-detail
oneview backend order API
Order detail information
+ Parameters
+ orderCode (required, string, vsba-nhas)
+ geid: FP_SG (string, optional) - global entity id
+ Default: FP_SG
+ nocache (boolean, optional, false) - bypass the cache when calling GCC order endpoint
+ Attributes (OrderDetail)
+ Headers
Authorization: bearer token
X-Contact-Id: case-id
+ Response 200 (application/json)
+ Attributes (OrderDetail)
+ Response 400 (application/json)
+ Attributes (Error)
+ Response 401 (application/json)
+ Attributes (Error)
+ Response 403 (application/json)
+ Attributes (Error)
+ Response 404 (application/json)
+ Attributes (Error)
+ Response 500 (application/json)
+ Attributes (Error)
+ Parameters
+ orderCode (required, string, vsba-nhas)
+ geid: FP_SG (string, optional) - global entity id
+ Default: FP_SG
+ nocache (boolean, optional, false) - bypass the cache when calling GCC order endpoint
+ Attributes (OrderReceipt)
+ Headers
Authorization: bearer token
X-Contact-Id: case-id
+ Response 200 (application/json)
+ Attributes (OrderReceipt)
+ Response 400 (application/json)
+ Attributes (Error)
+ Response 401 (application/json)
+ Attributes (Error)
+ Response 403 (application/json)
+ Attributes (Error)
+ Response 404 (application/json)
+ Attributes (Error)
+ Response 500 (application/json)
+ Attributes (Error)
list the order status of a current order
+ Parameters
+ orderCode (required, string, vsba-nhas)
+ geid: FP_SG (string, optional) - global entity id
+ Default: FP_SG
+ nocache (boolean, optional) - bypass cache system
+ Attributes (OrderStatusList)
+ Headers
Authorization: bearer token
X-Contact-Id: case-id
+ Response 200 (application/json)
+ Attributes (OrderStatusList)
+ Response 400 (application/json)
+ Attributes (Error)
+ Response 401 (application/json)
+ Attributes (Error)
+ Response 403 (application/json)
+ Attributes (Error)
+ Response 404 (application/json)
+ Attributes (Error)
+ Response 500 (application/json)
+ Attributes (Error)
+ Parameters
+ orderCode (required, string, vsba-nhas)
+ geid: FP_SG (string, optional) - global entity id
+ Default: FP_SG
+ Attributes (MissingItemsResponse)
+ Headers
Authorization: bearer token
X-Contact-Id: case-id
+ Attributes (MissingItemsParams)
+ Response 200 (application/json)
+ Attributes (MissingItemsResponse)
+ Response 400 (application/json)
+ Attributes (Error)
+ Response 401 (application/json)
+ Attributes (Error)
+ Response 403 (application/json)
+ Attributes (Error)
+ Response 404 (application/json)
+ Attributes (Error)
+ Response 500 (application/json)
+ Attributes (Error)
+ Parameters
+ orderCode (required, string, vsba-nhas)
+ geid: FP_SG (string, optional) - global entity id
+ Default: FP_SG
+ Headers
Authorization: bearer token
X-Contact-Id: case-id
+ Attributes (CancelOrderParams)
+ Response 200 (application/json)
+ Response 400 (application/json)
+ Attributes (Error)
+ Response 401 (application/json)
+ Attributes (Error)
+ Response 403 (application/json)
+ Attributes (Error)
+ Response 404 (application/json)
+ Attributes (Error)
+ Response 500 (application/json)
+ Attributes (Error)
+ Parameters
+ orderCode (required, string, vsba-nhas)
+ geid: FP_SG (GlobalEntityId, optional) - global entity id
+ Default: FP_SG
+ Attributes (RefundResponse)
+ Headers
Authorization: bearer token
X-Contact-Id: case-id
+ Attributes (RefundParams)
+ Response 200 (application/json)
+ Attributes (RefundResponse)
+ Response 400 (application/json)
+ Attributes (Error)
+ Response 401 (application/json)
+ Attributes (Error)
+ Response 403 (application/json)
+ Attributes (Error)
+ Response 404 (application/json)
+ Attributes (Error)
+ Response 500 (application/json)
+ Attributes (Error)
+ Parameters
+ orderCode (required, string, vsba-nhas)
+ geid: FP_SG (string, optional) - global entity id
+ Default: FP_SG
+ Headers
Authorization: bearer token
X-Contact-Id: case-id
+ Response 200 (application/json)
+ Attributes (OrderCommentList)
+ Response 400 (application/json)
+ Attributes (Error)
+ Response 401 (application/json)
+ Attributes (Error)
+ Response 403 (application/json)
+ Attributes (Error)
+ Response 404 (application/json)
+ Attributes (Error)
+ Response 500 (application/json)
+ Attributes (Error)
+ Headers
Authorization: bearer token
X-Contact-Id: case-id
+ Attributes (UpdateOrderCommentParam)
+ Response 200 (application/json)
+ Attributes (UpdateOrderCommentResponse)
+ Response 400 (application/json)
+ Attributes (Error)
+ Response 401 (application/json)
+ Attributes (Error)
+ Response 403 (application/json)
+ Attributes (Error)
+ Response 404 (application/json)
+ Attributes (Error)
+ Response 500 (application/json)
+ Attributes (Error)
List basket update history of an order
+ Parameters
+ orderCode (required, string, vsba-nhas)
+ geid: FP_SG (required, string, FP_SG)
+ Attributes (BasketUpdateHistory)
+ Headers
Authorization: Bearer token
X-Contact-Id: case-id
+ Response 200 (application/json)
+ Attributes (BasketUpdateHistory)
+ Response 400 (application/json)
+ Attributes (Error)
+ Response 401 (application/json)
+ Attributes (Error)
+ Response 403 (application/json)
+ Attributes (Error)
+ Response 404 (application/json)
+ Attributes (Error)
+ Response 500 (application/json)
+ Attributes (Error)
error_object (object)Error (object)cod, credit-card, online-payment (string)vsba-nhas (string, required) - order codevsba (string) - vendor code. usually used to get vendor detail informationjolibee (string) - vendor nameasd2sas (string) - Customer code. usually used to get constumer detail informationAndroid-foodpanda-5.9.0(258704) (string) - platform used for orderandroid (string) - device source of order. exp : androidhttp://unknown (string) - url to generate the invoicedo something (string)SGD (string) currency of the pricesSGD (string) currency of the pricesjolibee (string, required) - vendor namevsba-nhas (string, required) - vendor idjulie (string, required) - reporting agent namevouchercreditcredit+voucheronline_paymentonline_bankingcash_on_deliverypaypalapple_paygcashpaylahOrder modification not possible(string) - Reason label for requesting an order cancellation2D.4(string) - CCR for given cancel reasonFP_SG (string, required) - global entity ID4 (number, required) - minimum refund value0.5 (number, required) - granularity of refund value0.10 (number, required) - compensation valueSENDING_TO_VENDORDISPLAYED_AT_VENDORSENT_TO_LOGISTICSACCEPTEDCOURIER_NEAR_PICK_UPCOURIER_LEFT_PICK_UPCOURIER_NEAR_DROP_OFFPICKED_UPDELAYEDDELIVEREDORDER_MODIFICATION_NOT_POSSIBLEMISTAKE_ERRORDUPLICATE_ORDERLATE_DELIVERYUNABLE_TO_FINDFOOD_QUALITY_SPILLAGENEVER_DELIVEREDWRONG_ORDER_ITEMS_DELIVEREDVOUCHER_NOT_APPLIEDDELIVERY_ETA_TOO_LONGCUSTOMER_CANCELLATIONVENDOR_CANCELLATIONLOGISTIC_CANCELLATION11ST_KRAR_BGAR_CZAR_HUAP_PAAU_KRBAD_ARBK_DEBK_SGBO_CABT_KRCD_COCD_ECCD_GRCD_PECG_AECG_BHCG_EGCG_IQCG_KWCG_QACG_SADA_GRDJ_CZDJ_SKDN_BADN_MEDN_RSEF_GRFF_KRFOC_AEFOC_JOFOC_LBFOC_OMFOC_QAFOC_SAFO_AEFO_ATFO_CAFO_DEFO_ESFO_FIFO_HKFO_NOFO_SEFP_BDFP_BGFP_BNFP_GEFP_HKFP_INFP_KHFP_KZFP_MMFP_MYFP_LAFP_PHFP_PKFP_ROFP_SGFP_THFP_TWGM_KRHF_EGHG_SEHM_ROHS_BHHS_SALH_DEMJM_ATNP_HUNV_KRODR_PKOP_SEPDE_DEPDE_DE_DOPO_FIPPP_PLPP_CLPY_ARPY_BOPY_CLPY_DOPY_ECPY_HNPY_MXPY_PAPY_PRPY_PYPY_UYPY_VEPZ_ATPZ_HRTB_AETB_BHTB_JOTB_KWTB_OMTB_QATB_SATEST_INSTRUMENTATION_VATEST_VAYO_KRYS_TRVP_DEZO_AEVoucher 1Voucher 2Voucher 3Voucher 4Voucher 5SGD (string) currency of the prices