Post SKU

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

This API endpoint is used to create or update SKU records along with their associated product data (such as attributes and identifiers).

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

NOTE: Use these header/query parameter examples mentioned above to execute this endpoint on the right and retrieve a sample API response.


QUERY PARAMETERS

catalogKey (catalogId)
The unique internal identifier of a catalog in the system. This parameter ensures that all API operations are performed within the correct catalog associated with a specific customer.


replaceAttributes: would typically control how SKU attributes are handled during an update operation:

  • If true:
    All existing attributes of the SKU would be fully replaced by the attributes provided in the request payload. Any attributes not included in the request would be removed.

  • If false (or not provided):
    The API would merge/update only the provided attributes, leaving existing attributes unchanged.

Query parameters
catalogKey
string
replaceAttributes
string
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": [], "domainRelationshipMetaData": [ { "relationshipTableName": "Domain Rel Table 1", "relationshipRows": [ { "relatedDomainRecords": [ { "domain": "Supplier", "domainRecord": "Supplier A" }, { "domain": "State", "domainRecord": "India" } ], "relationshipAttributeValues": [ { "relationshipAttributeName": "Sku-Rel-Attribute-A", "relationshipAttributeValue": "Value-A1", "uomSymbol": "cm" }, { "relationshipAttributeName": "Sku-Rel-Attribute-B", "relationshipAttributeValue": "Value-B1" } ] }, { "relatedDomainRecords": [ { "domain": "Supplier", "domainRecord": "Supplier B" }, { "domain": "State", "domainRecord": "USA" } ], "relationshipAttributeValues": [ { "relationshipAttributeName": "Sku-Rel-Attribute-A", "relationshipAttributeValue": "Value-A2" }, { "relationshipAttributeName": "Sku-Rel-Attribute-B", "relationshipAttributeValue": "Value-B2", "uomSymbol": "mm" } ] } ] } ] } ]

Request Parameters


amazeKeySkuIdentifier (integer)

Internal identifier of the SKU in PCC.


customerSkuId (string)

External ID of SKU.


skuTitle (string)

Title associated with SKU.


type (string)

describes the type of SKU with possible values SKU/Product Family.


Taxonomy Details

residentTaxonomy.taxonomyPath (string)

Path of the taxonomy where the SKU resides.


residentTaxonomy.taxonomyCustomerId (string)

Customer ID of the taxonomy where the SKU resides.


crosslistedToTaxonomies.taxonomyPath (string)

Path of the taxonomy where the SKU is cross-listed.


crosslistedToTaxonomies.taxonomyCustomerId (string)

Customer ID of the taxonomy where the SKU is cross-listed.


mirroredToTaxonomies.taxonomyPath (string)

Path of the taxonomy where the SKU is mirrored.


mirroredToTaxonomies.taxonomyCustomerId (string)

Customer ID of the taxonomy where the SKU is mirrored.


mirroredToTaxonomies.domainName (string)

Name of the domain in which the taxonomy is mirrored.


SKU Attributes


skuAttributes.attributeName (string)

Name of the attribute used in the SKU.


skuAttributes.skuAttributeValues.value (string)

Value of the attribute associated with the SKU.


skuAttributes.customerAttributeId (string)

Customer ID of the attribute used in the SKU.


skuAttributes.locked (string)

Indicates whether the attribute is locked for modification.


skuAttributes.skuAttributeValues.uomName (string)

Unit of measure name for the attribute value.


skuAttributes.skuAttributeValues.uomSymbol (string)

Unit of measure symbol for the attribute value. 


Digital Assets

digitalAssets.digitalAssetName (string)

Name of the digital asset associated with the SKU.


digitalAssets.digitalAssetPublicURL (string)

Public URL to access the digital asset.


digitalAssets.digitalAssetThumbnailPublicURL (string)

Public URL for the thumbnail of the digital asset.


digitalAssets.isPrimary (string)

Indicates whether the asset is the primary asset. 


domainRelationshipMetaData (string)

Defines relationships between the SKU and multiple domain records (e.g., Supplier, State), along with additional attributes that describe each relationship. This structure allows you to capture contextual, multi-entity associations and store metadata specific to those relationships.


relationshipTableName (arrray of objects)

The name of the relationship table that groups related domain associations. This typically represents a logical relationship type (e.g., supplier-specific relationships).


 relationshipRows (array of objects)

A collection of relationship entries. Each row represents a single relationship instance between the SKU and a set of domain records, along with its associated attributes.


relatedDomainRecords (array of objects)

Specifies the domain entities involved in the relationship. Each object identifies a domain and the corresponding record linked to the SKU.

  • domain (string)

    The name of the domain (e.g., Supplier, State).

  • domainRecord (string)

    The specific record within the domain (e.g., Supplier A, India).

Note: This field is only populated when the corresponding domain has been configured and linked to the SKU.


relationshipAttributeValues (array of objects)

Defines attribute values associated with the relationship. These attributes provide additional context or metadata specific to the relationship instance.

  • relationshipAttributeName (string):

    The name of the relationship attribute.

  • relationshipAttributeValue (string):

    The value assigned to the relationship attribute.

Note: This field is only populated when the corresponding relationship attribute values has been defined & linked to the SKU otherwise an error gets displayed.

Responses
200

Successful response

Response Parameters


responseSummary.Count of SKUs sent in payload

Total number of SKUs included in the request payload.


responseSummary.Count of SKUs successfully loaded into PCC

Number of SKUs that were successfully created or updated in the system.


responseSummary.Count of SKUs which errored entirely 

Number of SKUs that failed completely during processing.


responseSummary.Count of SKUs which errored partially

Number of SKUs that encountered partial errors during processing.


responseSummary.Count of SKUs newly added 

Number of new SKUs created in the system.


responseSummary.Count of SKUs updated or moved

Number of SKUs that were updated or moved.


responseSummary.Count of new DAs

Number of digital assets created.


responseSummary.Newly added CustomerSkuIds 

List of external SKU IDs that were newly created.


responseSummary.Updated CustomerSkuIds

List of external SKU IDs that were updated.


failedSkuReport.skuKey

Internal identifier of the SKU that failed during processing.


failedSkuReport.customerSkuId

External ID of the SKU that failed.


failedSkuReport.partialFail

Indicates whether the failure was partial or complete.


failedSkuReport.failedRecords.location 

Location in the payload where the failure occurred.


failedSkuReport.failedRecords.payloadData 

The specific data in the payload that caused the failure.


failedSkuReport.failedRecords.reason 

Reason for the failure of the SKU operation. 


NOTE: Copy the response from the right panel and paste it into any editor (e.g., DOCX or Notepad++) to view the full API response.