Dokumentasi API : Lookup – Excel Headers

Pada halaman ini, akan dijelaskan penggunaaan API untuk berinterakasi dengan tabel lookup Excel Headers.


API List

Method ini digunakan untuk mendapatkan data excel headers yang tersedia.

Request

METHODURL
GEThttp://apiv2.mitrabunso.com/public/lookup/excelheaders/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
GETorderByTIDAKSTRINGParameter untuk pengurutan berdasarkan data

Response

{
    "message": "Data retrieved successfully",
    "show": "1",
    "total": 124,
    "data": [
        {
            "deleted_at": null,
            "id": "00f29f66-deb1-44e0-9a5e-fbbe1e86da39",
            "column": "3",
            "property": "awb",
            "marketplace": "50857582-9770-49be-82ff-0ab82e16ec9c",
            "marketplaceName": "Blibli",
            "created": {
                "date": "2022-05-05 15:07:40.000000",
                "timezone_type": 3,
                "timezone": "Asia/Bangkok"
            },
            "updated": {
                "date": "2022-05-05 15:07:40.000000",
                "timezone_type": 3,
                "timezone": "Asia/Bangkok"
            },
            "createdBy": "4c8eaf2f-ec3b-4e5a-93cc-549047c863ee",
            "updatedBy": "",
            "createdByName": "Henni Pertiwi",
            "updatedByName": null
        }
    ]
}

API Create

Method ini digunakan untuk memasukan data excel headers.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/lookup/excelheaders/create/{id_user}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 charakter id user
HEADAuthorizationYABearer TokenBearer Token Login
POSTpropertyYASTRINGproperty header excel
POSTcolumnYAINTnomor kolom property
POSTmarketplaceYASTRING36 character id marketplace

Response

{
    "message": "Data added successfully",
    "data": {
        "deleted_at": null,
        "id": "7a353e3b-fbea-4c30-973f-b785bd402cb1",
        "column": "1",
        "property": "customer_name",
        "marketplace": "85fdc3e8-8e4f-4711-b8c4-1a398268cdc3",
        "marketplaceName": null,
        "created": {
            "date": "2022-10-10 11:34:27.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "updated": {
            "date": "2022-10-10 11:34:27.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
        "updatedBy": "",
        "createdByName": null,
        "updatedByName": null
    }
}

API Update

Method ini digunakan untuk mengubah data excel headers.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/lookup/excelheaders/update/{id_user}/{id_excel_headers}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 character id user
GETid_excel_headersYASTRING36 character id excel headers
HEADAuthorizationYABearer TokenBearer Token Login
POSTpropertyYASTRINGproperty header excel
POSTcolumnYAINTnomor kolom property
POSTmarketplaceYASTRING36 character id marketplace

Response

{
    "message": "Data updated successfully",
    "data": {
        "deleted_at": null,
        "id": "7a353e3b-fbea-4c30-973f-b785bd402cb1",
        "column": "3",
        "property": "customer_name",
        "marketplace": "85fdc3e8-8e4f-4711-b8c4-1a398268cdc3",
        "marketplaceName": null,
        "created": {
            "date": "2022-10-10 11:34:27.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "updated": {
            "date": "2022-10-10 11:35:23.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
        "updatedBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
        "createdByName": null,
        "updatedByName": null
    }
}

API Details

Method ini digunakan untuk mendapatkan data details excel headers.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/lookup/excelheaders/details/{id_user}/{id_excel_headers}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 character id user
GETid_excel_headersYASTRING36 character id excel headers
HEADAuthorizationYABearer TokenBearer Token Login

Response

{
    "message": "Data retrieved successfully",
    "data": {
        "deleted_at": null,
        "id": "7a353e3b-fbea-4c30-973f-b785bd402cb1",
        "column": "1",
        "property": "customer_name",
        "marketplace": "85fdc3e8-8e4f-4711-b8c4-1a398268cdc3",
        "marketplaceName": "Bunso Direct Order",
        "created": {
            "date": "2022-10-10 11:34:27.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "updated": {
            "date": "2022-10-10 11:34:27.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
        "updatedBy": "",
        "createdByName": null,
        "updatedByName": null
    }
}

API Delete

Method ini digunakan untuk menghapus data excel headers.

Request

METHODURL
DELETEhttp://apiv2.mitrabunso.com/public/lookup/excelheaders/delete/{id_user}/{id_excel_headers}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 character id user
GETid_excel_headersYASTRING36 character id excel headers
HEADAuthorizationYABearer TokenBearer Token Login

Response

{
    "message": "data deleted successfully"
}

Leave a Reply