Dokumentasi API : Product – Products

Pada halaman ini, akan dijelaskan penggunaaan API untuk berinterakasi dengan tabel main products.


API List

Method ini digunakan untuk mendapatkan data products yang tersedia.

Request

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

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit 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": 12495,
    "data": [
        {
            "brand_name": "Samsung Galaxy Z Fold 3",
            "type_name": "Electroplating raCaseta",
            "color_name": "Merah",
            "category_name": "Phone Case",
            "brand_code": "SZFD30",
            "type_code": "1ERC",
            "color_code": "008",
            "deleted_at": null,
            "id": "05d67bc3-2fcf-41ca-b529-8cfe792f9df3",
            "color": "743a2358-ace5-11ec-b86f-f6f18f017643",
            "brand": "5623cc14-ace7-11ec-b86f-f6f18f017643",
            "type": "056615dc-73e0-4141-bde1-c9baab2559cb",
            "category": "4ba8b4c4-dd1d-4b82-b3c6-fc90dc207683",
            "composite": "4ba8b4c4-dd1d-4b82-b3c6-fc90dc207683056615dc-73e0-4141-bde1-c9baab2559cb5623cc14-ace7-11ec-b86f-f6f18f017643743a2358-ace5-11ec-b86f-f6f18f017643",
            "created": {
                "date": "2022-05-06 04:56:43.000000",
                "timezone_type": 3,
                "timezone": "Asia/Bangkok"
            },
            "updated": null,
            "createdBy": "5dff9be2-c24d-41dc-8078-1ebf9e3448f6",
            "updatedBy": "",
            "createdByName": "Albert Sebastian",
            "updatedByName": null
        }
    ]
}

API Create

Method ini digunakan untuk memasukan data products.

Request

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

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit id user
HEADAuthorizationYABearer TokenBearer Token Login
POSTbrandYASTRING36 digit id brand
POSTcolorYASTRING36 digit id color
POSTcategoryYASTRING36 digit id category
POSTtypeYASTRING36 digit id type

Response

{
    "message": "Data added successfully",
    "data": {
        "deleted_at": null,
        "id": "2a1b0efb-dfdf-4335-90ac-367fc9ca930e",
        "color": "743a2880-ace5-11ec-b86f-f6f18f017643",
        "brand": "0fed079f-8873-45c7-ae14-1d3038520687",
        "type": "23fca1d9-abac-4e00-83f4-e1416b3c65cf",
        "category": "f57109ea-1c3b-4d1a-ae84-4951c225ca69",
        "composite": "f57109ea-1c3b-4d1a-ae84-4951c225ca6923fca1d9-abac-4e00-83f4-e1416b3c65cf0fed079f-8873-45c7-ae14-1d3038520687743a2880-ace5-11ec-b86f-f6f18f017643",
        "created": {
            "date": "2022-10-08 12:41:02.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "updated": {
            "date": "2022-10-08 12:41:02.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 products.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/product/products/update/{id_user}/{id_products}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit id user
GETid_productsYASTRING36 digit id products
HEADAuthorizationYABearer TokenBearer Token Login
POSTbrandYASTRING36 digit id brand
POSTtypeYASTRING36 digit id type
POSTcolorYASTRING36 digit id color
POSTcategoryYASTRING36 digit id category

Response

{
    "message": "Data updated successfully",
    "data": {
        "deleted_at": null,
        "id": "08327d9a-67c4-4d71-88ef-518ddf859b26",
        "color": "743a2880-ace5-11ec-b86f-f6f18f017643",
        "brand": "5623cc14-ace7-11ec-b86f-f6f18f017643",
        "type": "056615dc-73e0-4141-bde1-c9baab2559cb",
        "category": "f57109ea-1c3b-4d1a-ae84-4951c225ca69",
        "composite": "f57109ea-1c3b-4d1a-ae84-4951c225ca69056615dc-73e0-4141-bde1-c9baab2559cb5623cc14-ace7-11ec-b86f-f6f18f017643743a2880-ace5-11ec-b86f-f6f18f017643",
        "created": {
            "date": "2022-05-06 04:56:43.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "updated": {
            "date": "2022-10-08 12:42:12.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "createdBy": "5dff9be2-c24d-41dc-8078-1ebf9e3448f6",
        "updatedBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
        "createdByName": null,
        "updatedByName": null
    }
}

API Details

Method ini digunakan untuk mendapatkan data details products.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/product/products/details/{id_user}/{id_products}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit id user
GETid_productsYASTRING36 digit id products
HEADAuthorizationYABearer TokenBearer Token Login

Response

{
    "message": "Data retrieved successfully",
    "data": {
        "brand_name": "Samsung Galaxy Z Fold 3",
        "type_name": "Electroplating raCaseta",
        "color_name": "Merah",
        "category_name": "Phone Case",
        "category_code": "CASE",
        "brand_code": "SZFD30",
        "type_code": "1ERC",
        "color_code": "008",
        "deleted_at": null,
        "id": "05d67bc3-2fcf-41ca-b529-8cfe792f9df3",
        "color": "743a2358-ace5-11ec-b86f-f6f18f017643",
        "brand": "5623cc14-ace7-11ec-b86f-f6f18f017643",
        "type": "056615dc-73e0-4141-bde1-c9baab2559cb",
        "category": "4ba8b4c4-dd1d-4b82-b3c6-fc90dc207683",
        "composite": "4ba8b4c4-dd1d-4b82-b3c6-fc90dc207683056615dc-73e0-4141-bde1-c9baab2559cb5623cc14-ace7-11ec-b86f-f6f18f017643743a2358-ace5-11ec-b86f-f6f18f017643",
        "created": {
            "date": "2022-05-06 04:56:43.000000",
            "timezone_type": 3,
            "timezone": "Asia/Bangkok"
        },
        "updated": null,
        "createdBy": "5dff9be2-c24d-41dc-8078-1ebf9e3448f6",
        "updatedBy": "",
        "createdByName": "Albert Sebastian",
        "updatedByName": null
    }
}

API Delete

Method ini digunakan untuk menghapus data products.

Request

METHODURL
DELETEhttp://apiv2.mitrabunso.com/public/product/products/delete/{id_user}/{id_products}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 digit id user
GETid_productsYASTRING36 digit id products
HEADAuthorizationYABearer TokenBearer Token Login

Response

{
    "message": "data deleted successfully"
}

Leave a Reply