Post Sku

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

This POST API is used to create new SKUs or update existing SKUs along with their associated data.

Header parameters
x-access-token
string
ExampleAHiWIfzgk1agkj29iosfL47m1ZEE30lEXbZksjCF7BhZTh1pQz220S70
X-Client-Secret
string
ExamplewkzrKnGGwisbYakLwKEM4L9N/JblJhN7
X-Customer-Code
string
ExampleAPITST
Query parameters
replaceAttributes
boolean
Examplefalse


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.


Body parameters
object
Example[ { "customerCode": "APITST", "catalogName": "APITST", "customerSkuId": "SM-757", "skuTitle": "Casual shoes for men", "type": "ProductFamily", "residentTaxonomy": { "taxonomyPath": "Footwear>Men>Shoes>Casuals>Sparx>SM-757", "taxonomyName": "SM-757", "taxonomyCustomerId": "Casual shoes for men - Black", "domainName": "Primary" }, "skuAttributes": [ { "attributeName": "Supplier-Brand", "customerAttributeId": "", "attributeType": "Domain", "skuAttributeValues": [ { "value": "Supplier-Nike" } ] }, { "attributeName": "Brand", "customerAttributeId": "49164", "attributeType": "String", "attributeMetaTags": [ { "name": "BRAND NAME", "description": "Brand name." } ], "skuAttributeValues": [ { "value": "Ken" } ] } ], "digitalAssets": [ { "digitalAssetName": "150H_SM-757-BKRD-5.jpg", "digitalAssetType": "Photo", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/725f093f-384c-418c-80b5-71a5fe6e0807.jpg", "digitalAssetThumbnailPublicURL": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/20ca1f23-ea1a-4c6f-9958-15a6282edd75.jpg", "isPrimary": false }, { "digitalAssetName": "150H_SM-757-CLBR-5.jpg", "digitalAssetType": "Photo", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/9b92541d-0696-4af5-becd-199f945b0645.jpg", "digitalAssetThumbnailPublicURL": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/752cb2f6-d041-4fe7-9ebf-d4e2579d5a06.jpg", "isPrimary": false }, { "digitalAssetName": "150H_SM-757-OGSA-5.jpg", "digitalAssetType": "Photo", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/126931ea-aa20-452d-bbe0-792b85d5ccd9.jpg", "digitalAssetThumbnailPublicURL": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/94434eb9-66f0-413d-9d1d-b764164dc969.jpg", "isPrimary": false }, { "digitalAssetName": "150W_SM-757-BKRD-5.jpg", "digitalAssetType": "Photo", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/6bc4c240-67ca-4cb6-a538-287fa5c064ec.jpg", "digitalAssetThumbnailPublicURL": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/6c01abf3-27a0-4f60-836b-e03bff40e8a8.jpg", "isPrimary": false }, { "digitalAssetName": "150W_SM-757-CLBR-5.jpg", "digitalAssetType": "Photo", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/1a5e71a5-595f-449f-afc1-e0aea70cdec9.jpg", "digitalAssetThumbnailPublicURL": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/431caef5-05e1-49e2-a911-f9dfc4844110.jpg", "isPrimary": false }, { "digitalAssetName": "150W_SM-757-OGSA-5.jpg", "digitalAssetType": "Photo", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/a8be2c7c-49de-4e8f-9a19-7da3309691f7.jpg", "digitalAssetThumbnailPublicURL": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/a7f79caa-71dd-424f-a784-a3db7ec2d9b5.jpg", "isPrimary": false }, { "digitalAssetName": "SM-757-BKRD-5.jpg", "digitalAssetType": "Photo", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/1a5d9e47-d2e9-43b5-ad53-498864ec7d2c.jpg", "digitalAssetThumbnailPublicURL": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/5f5b9dff-d0c6-4717-83c5-a2139bffdf79.jpg", "isPrimary": true }, { "digitalAssetName": "SM-757-CLBR-5.jpg", "digitalAssetType": "Photo", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/7364e974-a199-4205-948c-90ced8b76eb4.jpg", "digitalAssetThumbnailPublicURL": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/234c80c5-0d03-4f2f-b8cf-e74ceae10c64.jpg", "isPrimary": false }, { "digitalAssetName": "SM-757-OGSA-5.jpg", "digitalAssetType": "Photo", "digitalAssetPublicUrl": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/de1aa0fa-c40b-4839-97bb-4aa25b5bfe30.jpg", "digitalAssetThumbnailPublicURL": "https://amazeassets.bluemeteor.com/amaze-digital-asset/prod/APITST/692ca6a7-d398-4a44-9dd1-9c272b0d731d.jpg", "isPrimary": false } ] } ]

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. 

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.