Dokumentasi API : Order – Drafts

Pada halaman ini, akan dijelaskan penggunaaan API untuk melihat dan membuat draft penjualan


API List

Method ini digunakan untuk mendapatkan data draft order yang tersedia.

Request

METHODURL
GEThttp://apiv2.mitrabunso.com/public/order/drafts/list/{id_user}/{offsite}/{limit}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 character id user
GEToffsiteYAintoffsite data
GETlimitYAintlimit data
HEADAuthorizationYABearer TokenBearer Token Login
GETqTIDAKSTRINGParameter untuk pencarian

Response

{
    "message": "Data retrieved successfully",
    "data": [
        {
            "customer": {
                "name": "Hinato",
                "phone": "628000000000",
                "address": "Aparetmen Botanica Towe 1unit 19E Jl. Teuku Nyai Arief No 8\r\n\r\nKebayoran lama selatan - Kebayoran Lama\r\nKota Jakarta Selatan, DKI Jakarta",
                "provinceCode": "PR006",
                "provinceName": "DKI Jakarta",
                "cityCode": "C040",
                "cityName": "Kota Jakarta Selatan",
                "districtCode": "D0476",
                "districtName": "Kebayoran Lama",
                "postCode": "12240"
            },
            "sender": {
                "name": "Bunso Indonesia",
                "phone": "6281270253300"
            },
            "order": {
                "invoice": "ANDI2022101017403601",
                "courierId": "72061ca9-4fe9-4ddc-8ee5-d8855defd863",
                "courierName": "GRAB EXPRESS",
                "shopId": "96d56b01-80a0-43ce-aac5-d8756cb102ae",
                "shopName": "Blibli Bunso Indonesia",
                "shippingCost": "0",
                "awb": null,
                "adminNote": "RENJIRO - BLIBLI\nSamsung S10E Clear View Standing Cover Hitam (Phone Case)(1pcs) - Rp.15000, \n",
                "totalCost": 15000,
                "labelImage": null,
                "printType": "2",
                "assign": null
            },
            "details": [
                {
                    "productId": "1aed5e66-b1c3-4d3f-b3c0-af8abf06e2cc",
                    "qty": 1,
                    "productPrice": 15000,
                    "totalPrice": 15000,
                    "productName": "Samsung S10E Clear View Standing Cover Hitam (Phone Case)"
                }
            ],
            "draftId": "4031bc0b-8fb7-445d-a782-9368032b8f89"
        }
    ],
    "total": 14,
    "show": 1
}

API Save

Method ini digunakan untuk memasukan data atau mengubah data draft order yang ada.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/order/drafts/save/{id_user}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 charakter id user
HEADAuthorizationYABearer TokenBearer Token Login
POSTdataYAJSONData penjualan

Contoh JSON data :

{
  "customer": {
    "name": "Order Test #1",
    "phone": "6281728392",
    "address": "JL. Order #1 no 2",
    "provinceCode": "PR002",
    "provinceName": "Bangka Belitung",
    "cityCode": "C011",
    "cityName": "Kab. Bangka Barat",
    "districtCode": "D0060",
    "districtName": "Tempilang",
    "postCode": "33365"
  },
  "sender": {
    "name": "ALTHACELL.COM",
    "phone": "6283827513353"
  },
  "order": {
    "invoice": "ANDI2022101112595401",
    "courierId": "1ce46391-c1d1-4dc9-bcad-8d7a8140714c",
    "courierName": "Lion Parcel",
    "shopId": "02badb7c-a3ff-4e64-97f7-a3b82044dd83",
    "shopName": "ALTHASHOP",
    "shippingCost": "0",
    "awb": "ABC-DE0001",
    "adminNote": "Silicone Cover Samsung Note 10 plus Pink (Phone Case)(1pcs) - Rp.30000,",
    "totalCost": 30000,
    "labelImage": null,
    "printType": "2",
    "assign": null
  },
  "details": [
    {
      "productId": "0209640b-5767-4a39-9511-3c62ac15fb94",
      "qty": 1,
      "productPrice": 30000,
      "totalPrice": 30000,
      "productName": "Silicone Cover Samsung Note 10 plus Pink (Phone Case)"
    }
  ]
}

Response

{
    "message": "Data has been created succesfully.",
    "data": 1
}

API Delete

Method ini digunakan untuk menghapus data draft.

Request

METHODURL
DELETEhttp://apiv2.mitrabunso.com/public/order/drafts/delete/{id_user}/{id_draft}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 character id user
GETid_draftYASTRING36 character id draft
HEADAuthorizationYABearer TokenBearer Token Login

Response

{
    "message": "data deleted successfully"
}

Leave a Reply