Dokumentasi API : Product – Aliases

Pada halaman ini, akan dijelaskan penggunaaan API untuk berinterakasi dengan tabel Product Aliases.


API List

Method ini digunakan untuk mendapatkan data aliases yang tersedia.

Request

METHODURL
GEThttp://apiv2.mitrabunso.com/public/product/aliases/list/{id_user}/{id_product}/{offsite}/{limit}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit id user
GETid_productYASTRING36 digit id product
GEToffsiteYAintoffsite data
GETlimitYAintlimit data
HEADAuthorizationYABearer TokenBearer Token Login
GETqTIDAKSTRINGParameter untuk pencarian
GETorderByTIDAKSTRINGParameter untuk pengurutan berdasarkan data

Response

{
    "message": "Data retrieved successfully",
    "show": 3,
    "total": 3,
    "data": [
        {
            "deleted_at": null,
            "status": "1",
            "id": "e15f1303-cf73-4ea1-b095-9326d8fd56cb",
            "alias": "PRC0001",
            "product": "13628104-90c3-41a9-9074-c5c8b386f720",
            "shop": "03a0da07-1b3f-4512-81ed-0c01310666e4",
            "shopName": "Online Shop",
            "created": {
                "date": "2022-10-08 14:36:52.000000",
                "timezone_type": 3,
                "timezone": "Asia/Bangkok"
            },
            "updated": {
                "date": "2022-10-08 14:42:53.000000",
                "timezone_type": 3,
                "timezone": "Asia/Bangkok"
            },
            "createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
            "updatedBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
            "createdByName": "Andika Pratama",
            "updatedByName": "Andika Pratama"
        },
        {
            "deleted_at": null,
            "status": "1",
            "id": "e47acc54-5aa6-4e8f-a2a8-40e1fb544ee8",
            "alias": "PRC0001",
            "product": "13628104-90c3-41a9-9074-c5c8b386f720",
            "shop": "01a2f6a5-6761-4421-ac7d-7d09eb80fdf6",
            "shopName": "VBB AKSESORIS",
            "created": {
                "date": "2022-10-08 14:34:55.000000",
                "timezone_type": 3,
                "timezone": "Asia/Bangkok"
            },
            "updated": {
                "date": "2022-10-08 14:34:55.000000",
                "timezone_type": 3,
                "timezone": "Asia/Bangkok"
            },
            "createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
            "updatedBy": "",
            "createdByName": "Andika Pratama",
            "updatedByName": null
        },
        {
            "deleted_at": null,
            "status": "1",
            "id": "f6f2aaa5-751f-4be2-b2eb-e5a1d99aa674",
            "alias": "1ERCSZFD30002",
            "product": "13628104-90c3-41a9-9074-c5c8b386f720",
            "shop": "e9749a1c-a855-4810-a180-9f886dde67f9",
            "shopName": "Mobile Accessory",
            "created": {
                "date": "2022-06-08 09:03:07.000000",
                "timezone_type": 3,
                "timezone": "Asia/Bangkok"
            },
            "updated": {
                "date": "2022-06-08 09:03:07.000000",
                "timezone_type": 3,
                "timezone": "Asia/Bangkok"
            },
            "createdBy": "5dff9be2-c24d-41dc-8078-1ebf9e3448f6",
            "updatedBy": "5dff9be2-c24d-41dc-8078-1ebf9e3448f6",
            "createdByName": "Albert Sebastian",
            "updatedByName": "Albert Sebastian"
        }
    ]
}

API Create

Method ini digunakan untuk memasukan data aliases.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/product/aliases/create/{id_user}/{id_product}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit id user
GETid_productYASTRING36 digit id product
HEADAuthorizationYABearer TokenBearer Token Login
POSTaliasYASTRINGNama untuk aliases produk
POSTshopYASTRING36 digit id shop

Response

{
    "message": "Data added successfully",
    "data": {
        "deleted_at": null,
        "status": "1",
        "id": "e47acc54-5aa6-4e8f-a2a8-40e1fb544ee8",
        "alias": "PRC0001",
        "product": "13628104-90c3-41a9-9074-c5c8b386f720",
        "shop": "01a2f6a5-6761-4421-ac7d-7d09eb80fdf6",
        "shopName": null,
        "created": {
            "date": "2022-10-08 14:34:55.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "updated": {
            "date": "2022-10-08 14:34:55.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 aliases.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/product/aliases/update/{id_user}/{id_product}/{id_aliases}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit id user
GETid_productYASTRING36 digit id product
GETid_aliasesYASTRING36 digit id aliases
HEADAuthorizationYABearer TokenBearer Token Login
POSTaliasYASTRINGNama untuk aliases produk
POSTshopYASTRING36 digit id shop

Response

{
    "message": "Data updated successfully",
    "data": {
        "deleted_at": null,
        "status": "1",
        "id": "e15f1303-cf73-4ea1-b095-9326d8fd56cb",
        "alias": "PRC0001",
        "product": "13628104-90c3-41a9-9074-c5c8b386f720",
        "shop": "03a0da07-1b3f-4512-81ed-0c01310666e4",
        "shopName": null,
        "created": {
            "date": "2022-10-08 14:36:52.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "updated": {
            "date": "2022-10-08 14:40:46.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 aliases.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/product/aliases/details/{id_user}/{id_product}/{id_aliases}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit id user
GETid_productYASTRING36 digit id product
GETid_aliasesYASTRING36 digit id aliases
HEADAuthorizationYABearer TokenBearer Token Login

Response

{
    "message": "Data retrieved successfully",
    "data": {
        "deleted_at": null,
        "status": "1",
        "id": "e15f1303-cf73-4ea1-b095-9326d8fd56cb",
        "alias": "PRC0001",
        "product": "13628104-90c3-41a9-9074-c5c8b386f720",
        "shop": "01a2f6a5-6761-4421-ac7d-7d09eb80fdf6",
        "shopName": null,
        "created": {
            "date": "2022-10-08 14:36:52.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "updated": {
            "date": "2022-10-08 14:36:52.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 produk aliases.

Request

METHODURL
DELETEhttp://apiv2.mitrabunso.com/public/product/aliases/delete/{id_user}/{id_product}/{id_aliases}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit id user
GETid_productYASTRING36 digit id product
GETid_aliasesYASTRING36 digit id aliases
HEADAuthorizationYABearer TokenBearer Token Login

Response

{
    "message": "data deleted successfully"
}

Leave a Reply