Post Sku

Prev Next
Post
/amazeApiRest/rest/v1/catalogs/1/skus

This endpoint allows you to add SKUs (Stock Keeping Units) to a specified catalog. The request is made using the POST method. 

Header parameters
X-Access-Token
string
ExampleAHiWIfzgk1agkj29iosfL47m1ZEE30lEXbZksjCF7BhZTh1pQz220S70
X-Customer-Code
string
ExampleAPITST
X-Oauth-Provider
string
ExampleCODIFYD
Content-Type
string
Exampleapplication/json
X-Requested-With
string
ExampleXMLHttpRequest
x-authorization-mode
string
Examplepassword
X-Client-Secret
string
Example6CHewppLoyVJIVwDAkwEG9J1SRySiISh
Body parameters
object
Example[ { "customerCode": "APITST", "customerSkuId": "SKU-001", "skuTitle": "demo sku", "type": "SKU", "skuAttributes": [ { "attributeName": "ASIN", "customerAttributeId": "75887", "attributeType": "String", "skuAttributeValues": [ { "value": "ABA10010", "uomName": "Ampere", "uomSymbol": "amp" } ], "locked": false }, { "attributeName": "Brand", "customerAttributeId": "49164", "attributeType": "String", "skuAttributeValues": [ { "value": "456" } ], "locked": false } ], "residentTaxonomy": { "taxonomyPath": "Footwear>Men>Shoes>Casuals>Sparx>SM-757", "taxonomyName": "SM-757", "taxonomyCustomerId": "Casual shoes for men - Black", "domainName": "Primary" }, "digitalAssets": [] } ]

Request Body

The request body must be a JSON array. Each item in the array represents one SKU and contains the following details: 

Basic SKU Information

customerCode (string)

A code representing the customer. 


customerSkuId (string)

A unique identifier for the SKU assigned by the customer.


skuTitle (string)

The title or name of the SKU.


type (string)

Identifies the record type. This value is always "SKU". 


SKU Attributes


skuAttributes (array of objects) 

An array of attributes associated with the SKU, where each attribute includes:

  • attributeName (string)

    The name of the attribute.


  • customerAttributeId (string)

    A unique identifier for the attribute assigned by the customer.


  • attributeType (string) 

    The data type of the attribute (e.g., String, number etc).


  • skuAttributeValues (array of objects): An array of values for the attribute, where each value includes:

    • value (string)

      The actual value of the attribute.


    • uomName (string) 

      The full name of the unit used for the value (for example, Inches, Pounds). 


    • uomSymbol (string)

      The symbol for the unit of measure (for example, in, lb).


  • locked (boolean)

    Indicates if the attribute is locked. 

    • true = cannot be edited

    • false = can be edited


SKU Category Information


residentTaxonomy (object): Information about where the SKU belongs in the product category structure, which includes: 


  • taxonomyPath (string) 

    The full category path where the SKU is placed. 


  • taxonomyName (string) 

    The name of the taxonomy assigned to the SKU. 


  • taxonomyCustomerId (string) 

    A unique identifier for the taxonomy assigned by the customer.


  • domainName (string) 

    The domain name associated with the taxonomy.


Digital Assets

  • digitalAssets (array) 

    An array of digital assets associated with the SKU (currently empty in the provided example).

Responses
200

Successful response

Expected Response Format

Upon successful execution, the API will return a JSON object with the following structure:


responseSummary (object): Contains summary information about the SKU processing, including:

  • Count of SKUs sent in payload (integer) 

    The total number of SKUs sent in the request.


  • Count of SKUs successfully loaded into Amaze (integer) 

    The number of SKUs that were successfully added.


  • Count of SKUs which errored entirely (integer) 

    The number of SKUs that encountered errors during processing.


  • Count of SKUs which errored partially (integer) 

    The number of SKUs that experienced partial errors.


  • Count of SKUs newly added (integer) 

    The number of new SKUs added.


  • Count of SKUs updated or moved (integer) 

    The number of SKUs that were updated or moved.


  • Count of new DAs (integer) 

    The number of new digital assets added.


  • Newly added CustomerSkuIds (array) 

    An array of newly added customer SKU IDs.