{"openapi":"3.0.1","info":{"title":"Price","description":"Price management.\n Deprecated endpoints:
Uri | Method | Since | End of life |
|---|
","version":"1-apps"},"servers":[{"url":"api.test.bluestonepim.com/price"}],"tags":[{"name":"Technical","description":"To get technical information."},{"name":"Categories","description":"Operations related to categories."},{"name":"Groups","description":"Operations related to customer groups."},{"name":"Import","description":"Operations related to data import."},{"name":"Price Rules","description":"Operations related to price rules."},{"name":"Products","description":"API endpoints for managing with products."},{"name":"Rounding Rules","description":"Operations related to rounding rules."},{"name":"Synchronization Event","description":"Operations related to synchronization events."},{"name":"Synchronization","description":"Operations related to synchronization."}],"paths":{"/technical/version":{"get":{"tags":["Technical"],"summary":"Show service version.","operationId":"presentVersion","responses":{"200":{"description":"Show service version."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/customerGroups/{groupId}/price":{"get":{"tags":["Groups"],"summary":"Get price rule for customer group.","description":"Retrieves the price rule for a specific customer group.","operationId":"listPriceRule","parameters":[{"name":"groupId","in":"path","description":"ID of the customer group.","required":true,"schema":{"type":"string"}},{"name":"includeInactive","in":"query","description":"Include inactive price rules.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupPriceRuleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"},"500":{"description":"Cannot get price rule"}},"security":[{"oauth2":[]}]}},"/rules":{"get":{"tags":["Price Rules"],"summary":"List price rules.","description":"Get a paginated list of price rules.","operationId":"getRuleList","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sortField","in":"query","description":"Sorting field.","schema":{"type":"string","description":"Sort field.","default":"name","enum":["id","name","dateFrom","dateTo","type","value","active","modifiedBy","modifiedAt","createdBy","createdAt"]}},{"name":"sort","in":"query","description":"Sorting order.","schema":{"type":"string","description":"Sort order.","default":"asc","enum":["asc","desc"]}},{"name":"productIds","in":"query","description":"Product ID.","schema":{"type":"integer","description":"Product IDs","format":"int64"}},{"name":"categoryIds","in":"query","description":"Category ID.","schema":{"type":"integer","description":"Category IDs","format":"int64"}},{"name":"pimProductId","in":"query","description":"PIM product ID.","schema":{"type":"string","description":"PIM product ID"}},{"name":"pimCategoryId","in":"query","description":"PIM category ID.","schema":{"type":"string","description":"PIM category ID"}},{"name":"linkableType","in":"query","description":"Return only rules that can still be linked to this entity type.","schema":{"$ref":"#/components/schemas/LinkableType"}},{"name":"groupIds","in":"query","description":"Group ID.","schema":{"type":"integer","description":"Group IDs","format":"int64"}},{"name":"rangeFrom","in":"query","description":"Range from.","schema":{"type":"number","description":"Range from","format":"double"}},{"name":"rangeTo","in":"query","description":"Range to.","schema":{"type":"number","description":"Range to","format":"double"}},{"name":"name","in":"query","description":"Price rule name.","schema":{"type":"string","description":"Price rule name"}},{"name":"priceRuleType","in":"query","description":"Price rule type.","schema":{"$ref":"#/components/schemas/RuleType"}},{"name":"packageProductId","in":"query","description":"Package product ID.","schema":{"type":"integer","description":"Package product ID","format":"int64"}},{"name":"excludeCampaignRule","in":"query","description":"Excluding campaign rule.","schema":{"type":"boolean","description":"Exclude campaign rule","default":false}},{"name":"externalSource","in":"query","description":"External source.","allowEmptyValue":true,"schema":{"type":"string","description":"External source","example":"campaign"}},{"name":"active","in":"query","description":"Active.","schema":{"type":"boolean","description":"Active"}},{"name":"status","in":"query","description":"Status.","schema":{"$ref":"#/components/schemas/PriceRuleStatus"}}],"responses":{"200":{"description":"List of price rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPriceRuleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Price Rules"],"summary":"Create Price Rule.","description":"Endpoint to create a price rule.","operationId":"createPriceRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceRuleRequest"}}},"required":true},"responses":{"201":{"description":"Price rule created successfully","headers":{"Resource-Id":{"description":"Price rule ID","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceRuleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unable to create price rule"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Price Rules"],"summary":"Delete Price rule's data.","operationId":"removeRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleIdsRequest"}}},"required":true},"responses":{"200":{"description":"Price rule deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"}},"security":[{"oauth2":[]}]}},"/rules/{ruleId}":{"get":{"tags":["Price Rules"],"summary":"Get Price rule.","operationId":"getRuleById","parameters":[{"name":"ruleId","in":"path","description":"Price rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Price rule found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceRuleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"}},"security":[{"oauth2":[]}]},"put":{"tags":["Price Rules"],"summary":"Update Price rule's data.","operationId":"updateRule","parameters":[{"name":"ruleId","in":"path","description":"Price rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceRuleRequest"}}},"required":true},"responses":{"200":{"description":"Price rule updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceRuleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"},"422":{"description":"Unable to update price rule"}},"security":[{"oauth2":[]}]}},"/rules/{ruleId}/category":{"put":{"tags":["Price Rules"],"summary":"Link category with price rule.","operationId":"linkCategory","parameters":[{"name":"ruleId","in":"path","description":"Price rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithCategoryRequest"}}},"required":true},"responses":{"200":{"description":"Unlink category success","content":{"application/json":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"},"422":{"description":"Unable to update price rule"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Price Rules"],"summary":"Unlink category from price rule.","operationId":"unlinkCategory","parameters":[{"name":"ruleId","in":"path","description":"Price rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithCategoryRequest"}}},"required":true},"responses":{"200":{"description":"Unlink category success","content":{"application/json":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"},"422":{"description":"Unable to unlink category"}},"security":[{"oauth2":[]}]}},"/rules/{ruleId}/customerGroup":{"put":{"tags":["Price Rules"],"summary":"Link Customer Group with Price Rule.","operationId":"linkCustomerGroup","parameters":[{"name":"ruleId","in":"path","description":"Rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithGroupRequest"}}},"required":true},"responses":{"200":{"description":"Link group success"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"},"422":{"description":"Unable to update price rule"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Price Rules"],"summary":"Unlink Customer Group from Price Rule.","operationId":"unlinkCustomerGroup","parameters":[{"name":"ruleId","in":"path","description":"Rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithGroupRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"},"422":{"description":"Unable to unlink group"}},"security":[{"oauth2":[]}]}},"/rules/{ruleId}/product":{"put":{"tags":["Price Rules"],"summary":"Link Product with Price Rule.","operationId":"linkProduct","parameters":[{"name":"ruleId","in":"path","description":"Price rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithProductRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"},"422":{"description":"Unable to update price rule"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Price Rules"],"summary":"Unlink product from price rule.","operationId":"unlinkProduct","parameters":[{"name":"ruleId","in":"path","description":"Price rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithProductRequest"}}},"required":true},"responses":{"200":{"description":"Unlink product success","content":{"application/json":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Price rule not found"},"422":{"description":"Unable to unlink group"}},"security":[{"oauth2":[]}]}},"/products/pricing/explain":{"post":{"tags":["Products"],"summary":"Show applied price rule.","description":"The endpoint will show applied price rule for given request.","operationId":"getAppliedPriceRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceRequest"}}},"required":true},"responses":{"200":{"description":"Process success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAppliedRuleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot get applied price rule"}},"security":[{"oauth2":[]}]}},"/products/{productId}/price":{"put":{"tags":["Products"],"summary":"Update base price for product.","description":"Updates the base price for a product. Does not send notification and returns 204 No Content if the data does not change.","operationId":"updateBasePrice","parameters":[{"name":"productId","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBasePriceRequest"}}},"required":true},"responses":{"200":{"description":"Update base price success"},"204":{"description":"No update performed; data did not change; no notification sent."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Product not found in PIM"},"422":{"description":"Base price cannot be updated for a bundle product"},"500":{"description":"Cannot update base price"}},"security":[{"oauth2":[]}]},"post":{"tags":["Products"],"summary":"Get base price for product.","operationId":"getBasePrice","parameters":[{"name":"productId","in":"path","description":"Product ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBasePriceRequest"}}}},"responses":{"200":{"description":"Get base price success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePriceResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot get base price"}},"security":[{"oauth2":[]}]}},"/products/pricing":{"post":{"tags":["Products"],"summary":"Perform pricing.","description":"The endpoint may make use of cache layer to retrieve data. That's why sometimes the service may return data that will be perceived as old. The cache expiration is set to 5 seconds.","operationId":"getPricing","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceRequest"}}},"required":true},"responses":{"200":{"description":"Priced products","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot get price"}},"security":[{"oauth2":[]}]}},"/products/structure-with-rules":{"post":{"tags":["Products"],"summary":"Get product structure with applicable price rules.","description":"Returns products with their hierarchy information and all applicable price rules. This endpoint is not paginated: it returns one entry per resolved product, so \"total\" always equals the size of \"data\". Both may be smaller than the number of requested pimProductIds, because duplicate IDs are collapsed and IDs that do not resolve to a product are omitted.","operationId":"getProductStructureWithRules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductStructureRequest"}}},"required":true},"responses":{"200":{"description":"Product structure with rules retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductStructureResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"The request data is invalid"},"500":{"description":"Cannot retrieve product structure"}},"security":[{"oauth2":[]}]}},"/products/basePrice/list":{"post":{"tags":["Products"],"summary":"Get list of base prices.","operationId":"listBasePrice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBasePriceRequest"}}},"required":true},"responses":{"200":{"description":"List of base prices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBasePriceResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot list base prices"}},"security":[{"oauth2":[]}]}},"/products/list":{"get":{"tags":["Products"],"summary":"Get list of in-used products with pagination.","operationId":"listProducts","parameters":[{"name":"name","in":"query","description":"Product name.","schema":{"type":"string","description":"Name"}},{"name":"searchType","in":"query","description":"Search type.","required":true,"schema":{"$ref":"#/components/schemas/SearchType"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"List of products found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot list product"}},"security":[{"oauth2":[]}]}},"/products/import/unpublished":{"get":{"tags":["Products"],"summary":"Update unpublished product to remove duplicate variant group.","operationId":"removeDuplicateVariant","responses":{"200":{"description":"Remove success"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Error"}},"security":[{"oauth2":[]}]}},"/products":{"get":{"tags":["Products"],"summary":"Search for product.","operationId":"search","parameters":[{"name":"name","in":"query","description":"Product name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Search product success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot search product"}},"security":[{"oauth2":[]}]}},"/roundingRules":{"get":{"tags":["Rounding Rules"],"summary":"Get list of rounding rules with pagination.","operationId":"listRoundingRules","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sortField","in":"query","description":"Sort field.","schema":{"title":"Sorting field.","type":"string","example":"name","enum":["id","name","type","value","createdAt","createdBy","modifiedAt","modifiedBy"]},"example":"name"},{"name":"sort","in":"query","description":"Sorting order of the field.","schema":{"title":"Sorting order of the field.","type":"string","enum":["asc","desc"]},"example":"asc"}],"responses":{"200":{"description":"List rounding rules success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRoundingRuleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"List rounding rules error"}},"security":[{"oauth2":[]}]},"post":{"tags":["Rounding Rules"],"summary":"Create a rounding rule.","operationId":"createRoundingRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoundingRuleRequest"}}},"required":true},"responses":{"201":{"description":"Rounding rule created","headers":{"Resource-Id":{"description":"Rounding rule ID","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoundingRuleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unable to create rounding rule"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Rounding Rules"],"summary":"Delete a rounding rule.","operationId":"deleteRoundingRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoundingRuleIdsRequest"}}},"required":true},"responses":{"200":{"description":"Delete rounding rule success"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Rounding rule not found"},"500":{"description":"Cannot delete rounding rule"}},"security":[{"oauth2":[]}]}},"/roundingRules/{id}":{"get":{"tags":["Rounding Rules"],"summary":"Get a rounding rule by ID.","operationId":"getRoundingRuleById","parameters":[{"name":"id","in":"path","description":"Rounding rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Rounding rule found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoundingRuleResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Rounding rule not found"}},"security":[{"oauth2":[]}]},"put":{"tags":["Rounding Rules"],"summary":"Update a rounding rule's data.","operationId":"updateRoundingRule","parameters":[{"name":"id","in":"path","description":"Rounding rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoundingRuleRequest"}}},"required":true},"responses":{"200":{"description":"Rounding rule updated"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Rounding rule not found"},"422":{"description":"Unable to update rounding rule"}},"security":[{"oauth2":[]}]}},"/roundingRules/{id}/category":{"put":{"tags":["Rounding Rules"],"summary":"Link a category to a rounding rule.","operationId":"linkCategory_1","parameters":[{"name":"id","in":"path","description":"Rounding rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithCategoryRequest"}}},"required":true},"responses":{"200":{"description":"Rounding rule updated"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Rounding rule not found"},"422":{"description":"Unable to update rounding rule"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Rounding Rules"],"summary":"Unlink a category from a rounding rule.","operationId":"unlinkCategory_1","parameters":[{"name":"id","in":"path","description":"Rounding rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithCategoryRequest"}}},"required":true},"responses":{"200":{"description":"Rounding rule updated"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Rounding rule not found"},"422":{"description":"Unable to update rounding rule"}},"security":[{"oauth2":[]}]}},"/roundingRules/{id}/customerGroup":{"put":{"tags":["Rounding Rules"],"summary":"Link a customer group with a rounding rule","operationId":"linkCustomerGroup_1","parameters":[{"name":"id","in":"path","description":"Rounding rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithGroupRequest"}}},"required":true},"responses":{"200":{"description":"Link group success"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Rounding rule not found"},"422":{"description":"Unable to update rounding rule"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Rounding Rules"],"summary":"Unlink a customer group from a rounding rule.","operationId":"unlinkCustomerGroup_1","parameters":[{"name":"id","in":"path","description":"Rounding rule ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceWithGroupRequest"}}},"required":true},"responses":{"200":{"description":"Unlink group success"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Rounding rule not found"},"422":{"description":"Unable to update rounding rule"}},"security":[{"oauth2":[]}]}},"/sync-event/search":{"get":{"tags":["Synchronization Event"],"summary":"Search sync event by entity ID.","description":"This endpoint allows searching for sync events based on the entity ID.","operationId":"searchSyncEvent","parameters":[{"name":"entityId","in":"query","description":"The ID of the entity for which to search sync events.","schema":{"type":"string"}}],"responses":{"200":{"description":"Search sync event success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSyncEventResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Search sync event error"}},"security":[{"oauth2":[]}]}},"/sync/{jobId}/status":{"get":{"tags":["Synchronization"],"summary":"Get status for synchronization.","description":"This endpoint allows retrieving the status for a specific synchronization job.","operationId":"getSyncStatus","parameters":[{"name":"jobId","in":"path","description":"Job ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Synchronization status described","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SynchronizationStatus"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ID is not found"}},"security":[{"oauth2":[]}]}},"/sync/clients":{"post":{"tags":["Synchronization"],"summary":"Run full sync for client.","description":"This endpoint allows running a full synchronization for a client.","operationId":"syncClient","parameters":[{"name":"entity","in":"query","description":"The synchronization option.","schema":{"type":"string","enum":["CUSTOMER_GROUP","PRODUCT"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullSyncRequest"}}},"required":true},"responses":{"200":{"description":"Full Sync job created"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Invalid argument"},"500":{"description":"Full sync error"}},"security":[{"oauth2":[]}]}}},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"status":{"title":"Error status code.","type":"integer","format":"int32"},"error":{"title":"General error description.","type":"string"},"errorDetails":{"title":"List of errors details.","type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"}},"requestId":{"title":"Request ID used for logging.","type":"string"},"timestamp":{"title":"Error timestamp.","type":"integer","format":"int64"},"quotaLimitExceededDetails":{"title":"Additional entity id list related to error","type":"array","items":{"$ref":"#/components/schemas/QuotaLimitExceededDetails"}}}},"ErrorDetails":{"type":"object","properties":{"message":{"title":"Error message.","type":"string"},"field":{"title":"Error related field.","type":"string"},"rejectedValue":{"title":"Invalid value causing error.","type":"string"}}},"QuotaLimitExceededDetails":{"type":"object","properties":{"quota":{"title":"Quota name.","type":"string"},"message":{"title":"Quota limit message.","type":"string"},"limit":{"title":"Quota limit.","type":"integer","format":"int32"},"entityId":{"title":"Id of the entity that caused the quota limit to be exceeded.","type":"string","nullable":true},"entityType":{"title":"Type of the entity that caused the quota limit to be exceeded.","type":"string","nullable":true}}},"CategorySearchResponse":{"type":"object","properties":{"id":{"title":"ID.","type":"integer","format":"int64"},"refId":{"title":"Reference ID.","type":"string"},"name":{"title":"Name.","type":"string"},"type":{"title":"Type.","type":"string","enum":["BUNDLE","GROUP","SINGLE","VARIANT","FAMILY"]},"status":{"title":"Category Status.","type":"string","enum":["ACTIVE","INACTIVE"]}}},"CustomerSearchResponse":{"type":"object","properties":{"id":{"title":"ID.","type":"integer","format":"int64"},"refId":{"title":"Reference ID.","type":"string"},"name":{"title":"Name.","type":"string"},"type":{"title":"Type.","type":"string","enum":["BUNDLE","GROUP","SINGLE","VARIANT","FAMILY"]},"status":{"title":"Customer group status.","type":"string","enum":["ACTIVE","INACTIVE"]}}},"GroupPriceRuleResponse":{"type":"object","properties":{"rules":{"title":"Price rules result.","type":"array","items":{"$ref":"#/components/schemas/PriceRuleResponse"}}}},"PriceRuleResponse":{"title":"Rules list.","type":"object","properties":{"id":{"title":"Price rule ID.","type":"integer","format":"int64"},"name":{"title":"Price rule Name.","type":"string"},"type":{"title":"Type of price rule.","type":"string","enum":["PERCENTAGE_MARKUP","PERCENTAGE_SUBSIDY","FIXED_MARKUP","FIXED_SUBSIDY","FIXED_PRICE"]},"value":{"title":"Value.","type":"number","format":"double"},"discount":{"title":"Discount value.","type":"boolean"},"dateFrom":{"title":"Valid date from.","type":"string"},"dateTo":{"title":"Valid date to.","type":"string"},"active":{"title":"Active status.","type":"boolean"},"status":{"title":"Price rule status.","type":"string","enum":["ACTIVE","INACTIVE"]},"createdBy":{"title":"Created user.","type":"string"},"createdAt":{"title":"Created date.","type":"string"},"modifiedBy":{"title":"Updated user.","type":"string"},"modifiedAt":{"title":"Updated date.","type":"string"},"externalSource":{"title":"External source.","type":"string"},"externalSourceId":{"title":"External source ID.","type":"string"},"externalSourceStatus":{"title":"External status.","type":"string"},"minimumPrice":{"title":"Minimum price.","type":"number","format":"double"},"packageProductId":{"$ref":"#/components/schemas/ProductSearchResponse"},"categories":{"title":"Product categories that linked with this price rule.","type":"array","items":{"$ref":"#/components/schemas/CategorySearchResponse"}},"products":{"title":"Products that linked with this price rule.","type":"array","items":{"$ref":"#/components/schemas/ProductSearchResponse"}},"customerGroups":{"title":"Customer groups.","type":"array","items":{"$ref":"#/components/schemas/CustomerSearchResponse"}},"rangeFrom":{"title":"Range from.","type":"number","format":"double"},"rangeTo":{"title":"Range to.","type":"number","format":"double"}}},"ProductSearchResponse":{"type":"object","properties":{"id":{"title":"ID.","type":"integer","format":"int64"},"refId":{"title":"Reference ID.","type":"string"},"name":{"title":"Name.","type":"string"},"type":{"title":"type.","type":"string","enum":["BUNDLE","GROUP","SINGLE","VARIANT","FAMILY"]},"status":{"title":"Status.","type":"string","enum":["ACTIVE","INACTIVE"]},"number":{"title":"Number.","type":"string"}}},"SearchResponse":{"type":"object","properties":{"id":{"title":"ID.","type":"integer","format":"int64"},"refId":{"title":"Reference ID.","type":"string"},"name":{"title":"Name.","type":"string"},"type":{"title":"Type.","type":"string","enum":["BUNDLE","GROUP","SINGLE","VARIANT","FAMILY"]}}},"ImportResponse":{"type":"object","properties":{"importResult":{"$ref":"#/components/schemas/ImportResult"},"removeResult":{"$ref":"#/components/schemas/RemoveResult"}}},"ImportResult":{"type":"object","properties":{"created":{"title":"Created total.","type":"integer","format":"int32"},"updated":{"title":"Updated total.","type":"integer","format":"int32"},"skip":{"title":"Skip product ID list.","type":"array","items":{"type":"string"}}}},"RemoveResult":{"type":"object","properties":{"deleted":{"title":"Deleted total.","type":"integer","format":"int32"},"skip":{"title":"Skip product ID list.","type":"array","items":{"type":"string"}}}},"BasePriceRequest":{"type":"object","properties":{"pricesToSet":{"title":"Prices to set list.","type":"array","description":"pricesToSet","items":{"$ref":"#/components/schemas/ImportPriceField"}},"pricesToRemove":{"title":"Prices to remove list.","type":"array","description":"pricesToRemove","items":{"type":"string"}},"upsert":{"title":"If true, fetch and upsert product/category from PIM API before inserting price.","type":"boolean","description":"upsert","default":false}}},"ImportPriceField":{"required":["price","productId"],"type":"object","properties":{"productId":{"title":"Product ID.","type":"string","example":"productId"},"price":{"title":"Price.","minimum":0,"type":"number","example":100}}},"PriceRuleRequest":{"required":["dateFrom","discount","name","status","type","value"],"type":"object","properties":{"name":{"title":"Price rule name.","type":"string","example":"Name"},"type":{"title":"Price rule type.","type":"string","enum":["PERCENTAGE_MARKUP","PERCENTAGE_SUBSIDY","FIXED_MARKUP","FIXED_SUBSIDY","FIXED_PRICE"]},"value":{"title":"Price rule value.","maximum":99999999.99,"exclusiveMaximum":false,"type":"number","format":"double","example":1000},"minimumPrice":{"title":"Minimum price (available for price rule types Fixed subsidy and Percent subsidy).","maximum":99999999.99,"exclusiveMaximum":false,"type":"number","format":"double"},"discount":{"title":"Discount.","type":"boolean","example":false},"dateFrom":{"title":"Start date of the price rule.","type":"string","format":"date-time","example":"2018-09-01T00:00:00Z"},"dateTo":{"title":"End date of the price rule.","type":"string","format":"date-time","example":"2018-09-30T00:00:00Z"},"packageProductId":{"title":"Package product ID which want to link with this price rule.","type":"string"},"externalSource":{"title":"External source.","type":"string"},"externalSourceId":{"title":"External source ID.","type":"string"},"externalSourceStatus":{"title":"External source status.","type":"string"},"productIds":{"title":"Product ID list which want to link with this price rule.","type":"array","items":{"type":"string"}},"categoryIds":{"title":"Category ID list which want to link with this price rule.","type":"array","items":{"type":"string"}},"groupIds":{"title":"Customer group ID list which want to link with this price rule.","type":"array","items":{"type":"string"}},"rangeFrom":{"title":"Range from.","maximum":99999999.99,"exclusiveMaximum":false,"type":"number","format":"double","example":0},"rangeTo":{"title":"Range to.","maximum":99999999.99,"exclusiveMaximum":false,"type":"number","format":"double","example":0},"status":{"$ref":"#/components/schemas/PriceRuleStatus"}}},"PriceRuleStatus":{"title":"Status of the price rule.","type":"string","example":"INACTIVE","enum":["ACTIVE","INACTIVE"]},"ListPriceRuleResponse":{"type":"object","properties":{"data":{"title":"Result data.","type":"array","items":{"$ref":"#/components/schemas/PriceRuleDisplay"}},"total":{"title":"Total result.","type":"integer","format":"int64"}}},"PriceRuleDisplay":{"type":"object","properties":{"id":{"title":"Price rule ID.","type":"integer","format":"int64"},"name":{"title":"Price rule name.","type":"string"},"dateFrom":{"title":"Valid date from.","type":"string","format":"date-time"},"dateTo":{"title":"Valid date to.","type":"string","format":"date-time"},"type":{"title":"Price rule type.","type":"string","enum":["PERCENTAGE_MARKUP","PERCENTAGE_SUBSIDY","FIXED_MARKUP","FIXED_SUBSIDY","FIXED_PRICE"]},"value":{"title":"Price rule value.","type":"number","format":"double"},"minimumPrice":{"title":"Minimum price.","type":"number","format":"double"},"discount":{"title":"Discount.","type":"boolean"},"productNames":{"type":"array","items":{"$ref":"#/components/schemas/ProductSearchResponse"}},"categoryNames":{"type":"array","items":{"$ref":"#/components/schemas/CategorySearchResponse"}},"customerNames":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSearchResponse"}},"packageProductName":{"$ref":"#/components/schemas/ProductSearchResponse"},"active":{"title":"Active.","type":"boolean"},"status":{"title":"Status.","type":"string","enum":["ACTIVE","INACTIVE"]},"createdBy":{"title":"Created user.","type":"string"},"createdAt":{"title":"Created date.","type":"string","format":"date-time"},"modifiedBy":{"title":"Updated user.","type":"string"},"modifiedAt":{"title":"Updated date.","type":"string","format":"date-time"},"rangeFrom":{"title":"Range from.","type":"number","format":"double"},"rangeTo":{"title":"Range to.","type":"number","format":"double"},"externalSource":{"title":"External source.","type":"string"},"externalSourceId":{"title":"External source ID.","type":"string"}}},"LinkableType":{"type":"string","description":"Linkable entity type","enum":["PRODUCT","CATEGORY"]},"RuleType":{"type":"string","description":"Price rule type","enum":["PERCENTAGE_MARKUP","PERCENTAGE_SUBSIDY","FIXED_MARKUP","FIXED_SUBSIDY","FIXED_PRICE"]},"PriceWithCategoryRequest":{"required":["categoryIds"],"type":"object","properties":{"categoryIds":{"title":"Category product IDs list which want to link/unlink to this price rule.","type":"array","items":{"type":"string"}}}},"PriceWithGroupRequest":{"required":["groupIds"],"type":"object","properties":{"groupIds":{"title":"Customer groups ID which want to link/unlink with price rule.","type":"array","items":{"type":"string"}}}},"PriceWithProductRequest":{"required":["productIds"],"type":"object","properties":{"productIds":{"title":"Product IDs list which want to link/unlink to this price rule.","type":"array","items":{"type":"string"}},"packageProduct":{"title":"Is package product.","type":"boolean"}}},"RuleIdsRequest":{"required":["ruleIds"],"type":"object","properties":{"ruleIds":{"title":"Rules IDs list which want to remove.","type":"array","items":{"type":"integer","format":"int64"}}}},"AppliedRule":{"title":"Package rule.","type":"object","properties":{"id":{"title":"Package rule ID.","type":"integer","format":"int64"},"name":{"title":"Package rule name.","type":"string"},"ruleType":{"title":"Rule type.","type":"string","enum":["PERCENTAGE_MARKUP","PERCENTAGE_SUBSIDY","FIXED_MARKUP","FIXED_SUBSIDY","FIXED_PRICE"]},"value":{"title":"Package rule value.","type":"number","format":"double"},"minimumPrice":{"title":"Minimum price.","type":"number","format":"double"}}},"AppliedRuleItemResponse":{"title":"Responses list.","type":"object","properties":{"appliedRule":{"title":"Applied rules list","type":"array","items":{"$ref":"#/components/schemas/AppliedRuleResponse"}}}},"AppliedRuleResponse":{"title":"Applied rules list","type":"object","properties":{"productId":{"title":"Product ID.","type":"string"},"basePrice":{"title":"Base price.","type":"number","format":"double"},"priceRule":{"$ref":"#/components/schemas/AppliedRule"},"discountRule":{"$ref":"#/components/schemas/AppliedRule"},"packageRule":{"$ref":"#/components/schemas/AppliedRule"}}},"ListAppliedRuleResponse":{"type":"object","properties":{"responses":{"title":"Responses list.","type":"array","items":{"$ref":"#/components/schemas/AppliedRuleItemResponse"}}}},"BundleSpecification":{"type":"object","properties":{"bundleId":{"title":"Bundle ID.","type":"string"},"groupId":{"title":"Group ID.","type":"string"},"variantId":{"title":"Variant ID.","type":"string"},"quantity":{"title":"Quantity.","minimum":1,"type":"number"}}},"CalculationMode":{"title":"Price mode.","type":"string","enum":["B2B","B2C"]},"ItemRequest":{"required":["productId","quantity"],"type":"object","properties":{"productId":{"title":"Product ID.","type":"string"},"quantity":{"title":"Quantity.","minimum":1,"type":"integer","format":"int32","example":1,"default":1}}},"PriceItemRequest":{"required":["mode","products","vatAmount"],"type":"object","properties":{"customerGroups":{"title":"Customer groups IDs.","type":"array","items":{"type":"string"}},"mode":{"$ref":"#/components/schemas/CalculationMode"},"vatAmount":{"title":"Vat amount.","type":"number","format":"double","default":0},"includeReversePackages":{"title":"Include Reverse packages data.","type":"boolean","example":false,"default":false},"includePackages":{"title":"Include packages.","type":"boolean","example":false,"default":false},"specification":{"title":"Specifications.","type":"array","items":{"$ref":"#/components/schemas/BundleSpecification"}},"products":{"title":"Products list.","maxItems":2,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ItemRequest"}}}},"PriceRequest":{"type":"object","properties":{"requests":{"title":"Price requests list.","maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PriceItemRequest"}}}},"BasePriceResponse":{"type":"object","properties":{"price":{"title":"Price.","type":"number","format":"double"},"imported":{"title":"Imported.","type":"boolean"},"inherited":{"title":"Inherited.","type":"boolean"},"rules":{"title":"Rules list.","type":"array","items":{"$ref":"#/components/schemas/PriceRuleResponse"}}}},"GetBasePriceRequest":{"type":"object","properties":{"specification":{"title":"Specifications list.","type":"array","items":{"$ref":"#/components/schemas/BundleSpecification"}}}},"ItemResponse":{"type":"object","properties":{"basePrice":{"title":"Base price.","type":"number","format":"double"},"packagePriceRuleApplied":{"title":"Package price rule applied.","type":"boolean"},"originalPrice":{"title":"Original price.","type":"number","format":"double"},"originalPriceWithoutQuantity":{"title":"Original price without quantity.","type":"number","format":"double"},"originalPriceWithVat":{"title":"Original price with vat.","type":"number","format":"double"},"originalPriceWithoutQuantityWithVat":{"title":"Original price without quantity with vat.","type":"number","format":"double"},"campaignPrice":{"title":"Campaign price.","type":"number","format":"double"},"campaignPriceWithoutQuantity":{"title":"Campaign price without quantity.","type":"number","format":"double"},"campaignPriceWithVat":{"title":"Campaign price with vat.","type":"number","format":"double"},"campaignPriceWithoutQuantityWithVat":{"title":"Campaign price without quantity with vat.","type":"number","format":"double"},"price":{"title":"Price.","type":"number","format":"double"},"priceWithoutQuantity":{"title":"Price without quantity.","type":"number","format":"double"},"priceWithVat":{"title":"Price with vat.","type":"number","format":"double"},"priceWithoutQuantityWithVat":{"title":"Price without quantity with vat.","type":"number","format":"double"},"campaign":{"title":"Campaign.","type":"string"},"quantity":{"title":"Quantity.","type":"number","format":"double"},"productId":{"title":"Product ID.","type":"string"},"externalSource":{"title":"External source.","type":"string"},"externalSourceId":{"title":"External source ID.","type":"string"},"error":{"title":"Error.","type":"string"}}},"PriceItemResponse":{"title":"Price items list.","type":"object","properties":{"request":{"$ref":"#/components/schemas/PriceItemRequest"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ItemResponse"}}}},"PriceResponse":{"type":"object","properties":{"responses":{"title":"Price items list.","type":"array","items":{"$ref":"#/components/schemas/PriceItemResponse"}}}},"ApplicablePriceRule":{"type":"object","properties":{"priceRuleId":{"title":"Price rule ID.","type":"string"},"name":{"title":"Price rule name.","type":"string"},"scope":{"title":"Price rule scope.","type":"string","description":"Describes product and category targeting only. GENERAL means the rule has no product or category targeting; it does not mean the rule applies to every customer. Read groupIds for customer group restriction.","example":"PRODUCT","enum":["PRODUCT","VARIANT_GROUP","CATEGORY","GENERAL"]},"productIds":{"title":"Product IDs that this rule applies to.","type":"array","items":{"type":"string"}},"categoryIds":{"title":"Category IDs that this rule applies to.","type":"array","items":{"type":"string"}},"groupIds":{"title":"Customer group IDs that this rule applies to.","type":"array","items":{"type":"string"}},"type":{"title":"Price rule type.","type":"string","example":"Percentage markup"},"value":{"title":"Price rule value.","type":"number","format":"double","example":10}}},"CategoryAncestor":{"type":"object","properties":{"categoryId":{"title":"Category ID (PIM ID).","type":"string"},"level":{"title":"Hierarchy level (0 = parent, higher = current category).","type":"integer","format":"int32","example":0},"name":{"title":"Category name.","type":"string"}}},"ProductHierarchy":{"title":"Product hierarchy information.","type":"object","properties":{"catalogId":{"title":"Primary catalog ID (PIM ID).","type":"string"},"categoryAncestors":{"title":"Category ancestors from root to current.","type":"array","items":{"$ref":"#/components/schemas/CategoryAncestor"}}}},"ProductStructureResponse":{"type":"object","properties":{"data":{"title":"Result data.","type":"array","items":{"$ref":"#/components/schemas/ProductWithRulesResponse"}},"total":{"title":"Total result.","type":"integer","format":"int64"}}},"ProductWithRulesResponse":{"type":"object","properties":{"productId":{"title":"Product ID (PIM ID).","type":"string"},"variantGroupId":{"title":"Variant group ID (PIM ID).","type":"string"},"hierarchy":{"$ref":"#/components/schemas/ProductHierarchy"},"applicablePriceRules":{"title":"Applicable price rules for this product.","type":"array","items":{"$ref":"#/components/schemas/ApplicablePriceRule"}}}},"ProductStructureRequest":{"required":["pimProductIds"],"type":"object","properties":{"pimProductIds":{"title":"List of product IDs (PIM product IDs).","maxItems":100,"minItems":1,"type":"array","description":"Between 1 and 100 PIM product IDs. Duplicate IDs are collapsed and IDs that do not resolve to a product are omitted from the response.","items":{"type":"string"}},"customerGroups":{"title":"List of customer group IDs (PIM IDs).","type":"array","description":"Optional filter. When omitted or empty, no customer group filtering is applied and all active price rules are returned, including rules that target specific customer groups. When one or more IDs are supplied, only price rules with no group targeting, or targeting at least one of the supplied groups, are returned; a supplied ID that does not resolve to an existing customer group cannot match any group-targeted rule, it does not switch filtering off.","items":{"type":"string"}}},"description":"Request payload for retrieving product structure with applicable price rules."},"BasePriceItemRequest":{"required":["productId"],"type":"object","properties":{"productId":{"title":"Product ID.","type":"string"},"specification":{"title":"Specifications list.","type":"array","items":{"$ref":"#/components/schemas/BundleSpecification"}}}},"BasePriceItemResponse":{"title":"Responses list.","type":"object","properties":{"price":{"title":"Price.","type":"number","format":"double"},"imported":{"title":"Imported.","type":"boolean"},"inherited":{"title":"Inherited.","type":"boolean"},"request":{"$ref":"#/components/schemas/BasePriceItemRequest"}}},"ListBasePriceResponse":{"type":"object","properties":{"responses":{"title":"Responses list.","type":"array","items":{"$ref":"#/components/schemas/BasePriceItemResponse"}}}},"ListBasePriceRequest":{"type":"object","properties":{"requests":{"title":"Request list.","maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/BasePriceItemRequest"}}}},"ListProductResponse":{"type":"object","properties":{"data":{"title":"Result data.","type":"array","items":{"$ref":"#/components/schemas/ProductSearchResponse"}},"total":{"title":"Total result.","type":"integer","format":"int64"}}},"SearchType":{"type":"string","description":"Search type","default":"PRODUCT","enum":["PRODUCT","PACKAGE"]},"UpdateBasePriceRequest":{"type":"object","properties":{"price":{"title":"Base price.","type":"number","format":"double","example":0},"imported":{"title":"Imported.","type":"boolean","example":false}}},"RoundingRuleResponse":{"type":"object","properties":{"id":{"title":"Rounding rule ID.","type":"integer","format":"int64"},"name":{"title":"Rounding rule name.","type":"string"},"type":{"title":"Rounding rule type.","type":"string","enum":["precision","nearest"]},"rangeFrom":{"title":"Range from.","type":"number","format":"double"},"rangeTo":{"title":"Range to.","type":"number","format":"double"},"value":{"title":"Value.","type":"number","format":"double"},"categories":{"title":"Categories list.","type":"array","items":{"$ref":"#/components/schemas/CategorySearchResponse"}},"groups":{"title":"Customer groups list.","type":"array","items":{"$ref":"#/components/schemas/CustomerSearchResponse"}},"createdAt":{"title":"Created date.","type":"string","format":"date-time"},"createdBy":{"title":"Created user.","type":"string"},"modifiedAt":{"title":"Updated date.","type":"string","format":"date-time"},"modifiedBy":{"title":"Updated user.","type":"string"}}},"RoundingRuleRequest":{"required":["name","rangeFrom","type","value"],"type":"object","properties":{"name":{"title":"Rounding rule name.","type":"string","example":"Rounding rule name"},"categoryIds":{"title":"Categories ID list that want to link this rounding rule.","type":"array","items":{"type":"string"}},"rangeFrom":{"title":"Range from.","maximum":99999999.99,"exclusiveMaximum":false,"type":"number","format":"double","default":1000},"rangeTo":{"title":"Range to.","maximum":99999999.99,"exclusiveMaximum":false,"type":"number","format":"double","default":1000},"type":{"$ref":"#/components/schemas/RoundingRuleType"},"value":{"title":"Value.","type":"number","format":"double","default":1000}}},"RoundingRuleType":{"title":"Rounding rule type.","type":"string","enum":["precision","nearest"]},"RoundingRuleIdsRequest":{"required":["roundingRuleIds"],"type":"object","properties":{"roundingRuleIds":{"title":"Rounding Rules IDs list which want to remove.","type":"array","items":{"type":"integer","format":"int64"}}}},"ListRoundingRuleResponse":{"type":"object","properties":{"data":{"title":"Result data.","type":"array","items":{"$ref":"#/components/schemas/RoundingRuleResponse"}},"total":{"title":"Total result.","type":"integer","format":"int64"}}},"ListSyncEventResponse":{"type":"object","properties":{"data":{"title":"Result data.","type":"array","items":{"$ref":"#/components/schemas/SynchronizationEvent"}},"total":{"title":"Total result.","type":"integer","format":"int64"}}},"SynchronizationEvent":{"type":"object","properties":{"id":{"title":"Synchronization event ID.","type":"integer","format":"int64"},"synchronizationId":{"title":"Synchronization ID.","type":"integer","format":"int64"},"date":{"title":"Synchronization event date.","type":"string","format":"date-time"},"publishId":{"title":"Publish ID.","type":"string"},"status":{"title":"Synchronization event status.","type":"string","enum":["START","DONE","FAILED","IN_PROGRESS"]},"eventType":{"title":"Synchronization event type.","type":"string","enum":["PRODUCTS","CUSTOMERS","NON_PUBLISHED_PRODUCTS","NON_PUBLISHED_CATEGORIES","FULL_SYNC","FULL_SYNC_PRODUCTS","FULL_SYNC_CUSTOMERS","ORGANIZATION","CAMPAIGN_STATUS"]},"result":{"title":"Synchronization event result.","type":"string"},"entityIds":{"title":"Entity ID list.","type":"array","items":{"title":"Entity ID list.","type":"string"}}}},"ListSyncStatusResponse":{"type":"object","properties":{"data":{"title":"Result data.","type":"array","items":{"$ref":"#/components/schemas/SynchronizationStatus"}},"total":{"title":"Total result.","type":"integer","format":"int64"}}},"ProcessResult":{"type":"object","properties":{"success":{"title":"Success result.","type":"integer","format":"int32"},"failPimId":{"title":"Failed data ID.","uniqueItems":true,"type":"array","items":{"title":"Failed data ID.","type":"string"}},"errorMsg":{"title":"Error message.","uniqueItems":true,"type":"array","items":{"title":"Error message.","type":"string"}}}},"SyncDataResult":{"title":"Synchronization result.","type":"object","properties":{"products":{"$ref":"#/components/schemas/SyncResult"},"categories":{"$ref":"#/components/schemas/SyncResult"},"groups":{"$ref":"#/components/schemas/SyncResult"}}},"SyncResult":{"type":"object","properties":{"created":{"$ref":"#/components/schemas/ProcessResult"},"updated":{"$ref":"#/components/schemas/ProcessResult"},"deleted":{"$ref":"#/components/schemas/ProcessResult"}}},"SynchronizationStatus":{"type":"object","properties":{"id":{"title":"Synchronization ID.","type":"string"},"type":{"title":"Synchronization type.","type":"string","enum":["PRODUCTS","CUSTOMERS","NON_PUBLISHED_PRODUCTS","NON_PUBLISHED_CATEGORIES","FULL_SYNC","FULL_SYNC_PRODUCTS","FULL_SYNC_CUSTOMERS","ORGANIZATION","CAMPAIGN_STATUS"]},"date":{"title":"Synchronization date time.","type":"string","format":"date-time"},"status":{"title":"Synchronization status.","type":"string","enum":["START","DONE","FAILED","IN_PROGRESS"]},"result":{"$ref":"#/components/schemas/SyncDataResult"},"message":{"title":"Synchronization message.","type":"string"}}},"FullSyncRequest":{"type":"object","properties":{"clients":{"title":"List of Organization Id.","type":"array","items":{"type":"string"}},"includeClient":{"title":"Include client.","type":"boolean"}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://idp.test.bluestonepim.com/op/token","scopes":{"openid profile systemRoles permissions organization email name nickname":"All needed scopes."}}}}}},"x-amazon-apigateway-api-key-source":"AUTHORIZER"}