Product API

Product Brand

Create Product Brand

Description Create new Product Brand
Endpoint {AnalyticsManagerDataManagerApiAddress}/odata/PostProductBrands
Method POST
Request Headers {AToken}
Body - FormData Key: ProductBrands
Value: [
    {
        "BrandName": "Brand A"
    },
    {
        "BrandName": "Brand B"
    },
    {
        "BrandName": "Brand C"
    }
]
Response [
    {
        "Id": 101,
        "BrandName": "Brand A",
        "LastUpdateDateTime": null,
        "CompanyId": 1,
        "CreatedDateTime": "2021-10-16T08:50:24.9837226Z"
    },
    {
        "Id": 102,
        "BrandName": "Brand B",
        "LastUpdateDateTime": null,
        "CompanyId": 1,
        "CreatedDateTime": "2021-10-16T08:50:24.9838209Z"
    },
    {
        "Id": 103,
        "BrandName": "Brand C",
        "LastUpdateDateTime": null,
        "CompanyId": 1,
        "CreatedDateTime": "2021-10-16T08:50:24.9838213Z"
    }
]
Remark Please record down the "Id" value as you will need to use this as reference key for update / delete / linkage to other entity later

Read Product Brand

Description Pull created product brand under the company account
Endpoint {AnalyticsManagerDataManagerApiAddress}/odata/GetProductBrands
Method GET
Request Headers {AToken}
Response {
    "value": [
        {
            "Id": 103,
            "BrandName": "Brand C",
            "LogoPath": null,
            "LastUpdateDateTime": "2021-10-16T12:28:32.75Z",
            "CompanyId": 1,
            "CreatedDateTime": "2021-10-16T08:50:24.983Z",
            "NumberOfProducts": 0,
            "ServerDomainPath": null,
            "EslactionLogId": null,
            "Company": null,
            "Products": []
        },
        {
            "Id": 102,
            "BrandName": "Brand B",
            "LogoPath": null,
            "LastUpdateDateTime": null,
            "CompanyId": 1,
            "CreatedDateTime": "2021-10-16T08:50:24.983Z",
            "NumberOfProducts": 0,
            "ServerDomainPath": null,
            "EslactionLogId": null,
            "Company": null,
            "Products": []
        },
        {
            "Id": 101,
            "BrandName": "Brand A",
            "LogoPath": null,
            "LastUpdateDateTime": null,
            "CompanyId": 1,
            "CreatedDateTime": "2021-10-16T08:50:24.983Z",
            "NumberOfProducts": 0,
            "ServerDomainPath": null,
            "EslactionLogId": null,
            "Company": null,
            "Products": []
        }
    ],
    "count": 0
}

Update Product Brand

Description Update existing product brand
Endpoint {AnalyticsManagerDataManagerApiAddress}/odata/UpdateProductBrands
Method PATCH
Request Headers {AToken}
Body - JSON [
    {
        "Id": 103,
        "BrandName": "New product name A"
    },
    {
        "Id": 96,
        "BrandName": "New product name B"
    }
]
Remark Mandatory field:
- Id

Delete Product Brand

Description Delete existing product brand
Endpoint {AnalyticsManagerDataManagerApiAddress}/odata/DeleteProductBrands
Method DELETE
Request Headers {AToken}
Body - JSON [
    {
        "Id": 103
    },
    {
        "Id": 96
    }
]
Remark Mandatory field:
- Id
Pages: 1 2 3 4
Updated on October 28, 2024