Fetch Master SKUs

This API gives all the SKUs details present in sales channel catalogue(i.e. Sales channel listing).

Basic Information

  • Method: GET
  • URI: /master/skus
  • Response Format: JSON

Headers

The following headers should be sent along with the request

  • Accept: application/json
  • Authorization: Your API Key

Request

Below table list the request parameters which can be sent to Fetch SKUs API to filter records.

{info} The request parameters should be sent as query parameters in the URL.

Parameter Type Required Description
per_page Number No How many records you want at a time
page Number No Page number used for pagination
sku_codes[] Array of Strings No SKU codes to fetch. Only the matched items will be returned in the response


Sample Request

https://dev-fc-api.aymakan.net/api/v1/master/skus?per_page=10&page=1&sku_codes[]=SKU-TV-123451&sku_codes[]=SKU-MOB-789

Response

Sample response is added here:

{
    "success": true,
    "message": "",
    "data": [
        {
            "sku_code": "new_sku_2_master233",
            "name": "New SKU 2 - Master",
            "description": "This is a sample product description.",
            "cost": 25.99,
            "retail_price": 49.99,
            "selling_price": 39.99,
            "display_selling_price": "39.99 SAR",
            "display_retail_price": "49.99 SAR",
            "category": [],
            "product": {
                "name": "",
                "handling_type": "",
                "unit": "",
                "type": "simple",
                "description": ""
            },
            "dimensions": {
                "length": {
                    "length": 10,
                    "unit": "cm"
                },
                "breadth": {
                    "breadth": 5,
                    "unit": "cm"
                },
                "height": {
                    "height": 15,
                    "unit": "cm"
                }
            },
            "barcodes": [
                "new-sku-barcode-2233"
            ],
            "images": [],
            "attributes": [
                {
                    "name": "color",
                    "sku_attribute_variation": {
                        "name": "blue"
                    }
                }
            ],
            "handling_type": "hot",
            "type": "simple",
            "status": "live",
            "unit": "pcs",
            "is_perishable": false,
            "country_of_origin": "Sample Country",
            "is_weighted": false,
            "configuration": {
                "weight": {
                    "min": "5 kg",
                    "max": "10 kg",
                    "type": "range"
                }
            },
            "custom_attribute": [],
            "created_by": "474",
            "updated_by": "474",
            "created_at": "2024-01-08T12:07:01.729Z",
            "updated_at": "2024-01-08T12:09:17.65Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 8,
        "per_page": 1,
        "total": 8
    }
}