{ "components": { "schemas": { "AddressData": { "additionalProperties": false, "properties": { "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Line 1" }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Line 2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "house_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "House Number" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Street" } }, "required": [ "first_name", "last_name", "country_code", "address_line_1", "address_line_2", "house_number", "street", "postal_code", "city", "region", "phone" ], "title": "AddressData", "type": "object" }, "AllocationData": { "additionalProperties": false, "properties": { "location_code": { "title": "Location Code", "type": "string" }, "location_id": { "title": "Location Id", "type": "string" }, "location_name": { "title": "Location Name", "type": "string" }, "on_hand": { "title": "On Hand", "type": "integer" } }, "required": [ "location_id", "location_code", "location_name", "on_hand" ], "title": "AllocationData", "type": "object" }, "AnalyticsMeta": { "additionalProperties": false, "properties": { "period": { "$ref": "#/components/schemas/AnalyticsPeriodData" }, "request_id": { "maxLength": 100, "minLength": 1, "title": "Request Id", "type": "string" } }, "required": [ "request_id", "period" ], "title": "AnalyticsMeta", "type": "object" }, "AnalyticsPageMeta": { "additionalProperties": false, "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "period": { "$ref": "#/components/schemas/AnalyticsPeriodData" }, "request_id": { "maxLength": 100, "minLength": 1, "title": "Request Id", "type": "string" } }, "required": [ "request_id", "period", "pagination" ], "title": "AnalyticsPageMeta", "type": "object" }, "AnalyticsPeriodData": { "additionalProperties": false, "properties": { "as_of": { "format": "date-time", "title": "As Of", "type": "string" }, "days": { "title": "Days", "type": "integer" }, "started_at": { "format": "date-time", "title": "Started At", "type": "string" } }, "required": [ "days", "started_at", "as_of" ], "title": "AnalyticsPeriodData", "type": "object" }, "AnalyticsResponse_OverviewData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/OverviewData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/AnalyticsPageMeta" }, { "$ref": "#/components/schemas/AnalyticsMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "AnalyticsResponse[OverviewData]", "type": "object" }, "AnalyticsResponse_list_MetricData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/MetricData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/AnalyticsPageMeta" }, { "$ref": "#/components/schemas/AnalyticsMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "AnalyticsResponse[list[MetricData]]", "type": "object" }, "AnalyticsResponse_list_OccurrenceData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/OccurrenceData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/AnalyticsPageMeta" }, { "$ref": "#/components/schemas/AnalyticsMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "AnalyticsResponse[list[OccurrenceData]]", "type": "object" }, "ApiError": { "additionalProperties": false, "properties": { "code": { "enum": [ "request.malformed", "authentication.required", "authentication.invalid_credentials", "authorization.scope_denied", "authorization.ip_not_allowed", "authorization.client_ip_unverified", "entitlements.api_disabled", "entitlements.operation_disabled", "entitlements.limit_exceeded", "entitlements.resource_blocked", "resource.not_found", "request.method_not_allowed", "resource.version_conflict", "resource.state_conflict", "resource.in_use", "resource.already_exists", "idempotency.key_reused", "request.too_large", "request.unsupported_media_type", "request.validation_failed", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout" ], "title": "Code", "type": "string" }, "fields": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FieldError" }, "type": "array" }, { "type": "null" } ], "title": "Fields" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message" ], "title": "ApiError", "type": "object" }, "ApiResponse_BrandData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/BrandData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[BrandData]", "type": "object" }, "ApiResponse_CampaignData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CampaignData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[CampaignData]", "type": "object" }, "ApiResponse_CategoryDetailData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CategoryDetailData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[CategoryDetailData]", "type": "object" }, "ApiResponse_ContextData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ContextData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[ContextData]", "type": "object" }, "ApiResponse_DeliveryDetailData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/DeliveryDetailData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[DeliveryDetailData]", "type": "object" }, "ApiResponse_FeatureData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/FeatureData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[FeatureData]", "type": "object" }, "ApiResponse_FeatureValueData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/FeatureValueData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[FeatureValueData]", "type": "object" }, "ApiResponse_MutationData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/MutationData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[MutationData]", "type": "object" }, "ApiResponse_OrderDetailData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/OrderDetailData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[OrderDetailData]", "type": "object" }, "ApiResponse_PageDetailData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PageDetailData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[PageDetailData]", "type": "object" }, "ApiResponse_ProductDetailData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ProductDetailData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[ProductDetailData]", "type": "object" }, "ApiResponse_ProductVariantData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ProductVariantData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[ProductVariantData]", "type": "object" }, "ApiResponse_RequestDetailData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RequestDetailData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[RequestDetailData]", "type": "object" }, "ApiResponse_RuleDetailData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RuleDetailData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[RuleDetailData]", "type": "object" }, "ApiResponse_StockDetailData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/StockDetailData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[StockDetailData]", "type": "object" }, "ApiResponse_TokenData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/TokenData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[TokenData]", "type": "object" }, "ApiResponse_VariantOptionData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[VariantOptionData]", "type": "object" }, "ApiResponse_VariantValueData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/VariantValueData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[VariantValueData]", "type": "object" }, "ApiResponse_WarehouseData_": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WarehouseData" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[WarehouseData]", "type": "object" }, "ApiResponse_list_BrandData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/BrandData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[BrandData]]", "type": "object" }, "ApiResponse_list_CampaignData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/CampaignData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[CampaignData]]", "type": "object" }, "ApiResponse_list_CategorySummaryData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/CategorySummaryData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[CategorySummaryData]]", "type": "object" }, "ApiResponse_list_DeliveryData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/DeliveryData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[DeliveryData]]", "type": "object" }, "ApiResponse_list_FeatureData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/FeatureData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[FeatureData]]", "type": "object" }, "ApiResponse_list_FeatureValueData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/FeatureValueData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[FeatureValueData]]", "type": "object" }, "ApiResponse_list_LocationData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/LocationData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[LocationData]]", "type": "object" }, "ApiResponse_list_OrderSummaryData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/OrderSummaryData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[OrderSummaryData]]", "type": "object" }, "ApiResponse_list_PageSummaryData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/PageSummaryData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[PageSummaryData]]", "type": "object" }, "ApiResponse_list_ProductSummaryData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ProductSummaryData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[ProductSummaryData]]", "type": "object" }, "ApiResponse_list_ProductVariantData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ProductVariantData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[ProductVariantData]]", "type": "object" }, "ApiResponse_list_RequestSummaryData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/RequestSummaryData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[RequestSummaryData]]", "type": "object" }, "ApiResponse_list_RuleSummaryData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/RuleSummaryData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[RuleSummaryData]]", "type": "object" }, "ApiResponse_list_StockData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/StockData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[StockData]]", "type": "object" }, "ApiResponse_list_VariantOptionData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[VariantOptionData]]", "type": "object" }, "ApiResponse_list_VariantValueData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/VariantValueData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[VariantValueData]]", "type": "object" }, "ApiResponse_list_WarehouseData__": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/WarehouseData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[WarehouseData]]", "type": "object" }, "AvailabilityData": { "additionalProperties": false, "properties": { "available_from": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Available From" }, "available_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Available Until" }, "is_available": { "title": "Is Available", "type": "boolean" } }, "required": [ "is_available", "available_from", "available_until" ], "title": "AvailabilityData", "type": "object" }, "BrandCreate": { "additionalProperties": false, "properties": { "name": { "maxLength": 160, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "BrandCreate", "type": "object" }, "BrandData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "number": { "title": "Number", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "created_at", "updated_at", "name", "version" ], "title": "BrandData", "type": "object" }, "BrandUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "name": { "maxLength": 160, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name", "expected_version" ], "title": "BrandUpdate", "type": "object" }, "CampaignCreate": { "additionalProperties": false, "properties": { "audience": { "default": "all", "enum": [ "all", "guest", "customer", "selected" ], "title": "Audience", "type": "string" }, "benefit_type": { "default": "percentage", "enum": [ "percentage", "fixed", "none" ], "title": "Benefit Type", "type": "string" }, "category_ids": { "items": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, "maxItems": 1000, "title": "Category Ids", "type": "array" }, "code": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{6,16}$", "type": "string" }, { "type": "null" } ], "title": "Code" }, "combine_coupons": { "default": false, "title": "Combine Coupons", "type": "boolean" }, "combine_promotions": { "default": false, "title": "Combine Promotions", "type": "boolean" }, "customer_ids": { "items": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, "maxItems": 1000, "title": "Customer Ids", "type": "array" }, "ends_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Ends At" }, "free_shipping": { "default": false, "title": "Free Shipping", "type": "boolean" }, "markets": { "items": { "$ref": "#/components/schemas/MarketData-Input" }, "maxItems": 1000, "minItems": 1, "title": "Markets", "type": "array" }, "minimum_quantity": { "default": 1, "maximum": 2147483647, "minimum": 1, "title": "Minimum Quantity", "type": "integer" }, "name": { "maxLength": 160, "minLength": 1, "title": "Name", "type": "string" }, "per_customer_limit": { "default": -1, "maximum": 2147483647, "minimum": -1, "title": "Per Customer Limit", "type": "integer" }, "percentage": { "default": "10", "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "title": "Percentage", "type": "string" }, "product_ids": { "items": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, "maxItems": 1000, "title": "Product Ids", "type": "array" }, "product_scope": { "default": "all", "enum": [ "all", "selected" ], "title": "Product Scope", "type": "string" }, "show_account": { "default": false, "title": "Show Account", "type": "boolean" }, "show_cart": { "default": false, "title": "Show Cart", "type": "boolean" }, "show_product": { "default": false, "title": "Show Product", "type": "boolean" }, "starts_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Starts At" }, "usage_limit": { "default": -1, "maximum": 2147483647, "minimum": -1, "title": "Usage Limit", "type": "integer" } }, "required": [ "name", "markets" ], "title": "CampaignCreate", "type": "object" }, "CampaignData": { "additionalProperties": false, "properties": { "audience": { "default": "all", "enum": [ "all", "guest", "customer", "selected" ], "title": "Audience", "type": "string" }, "benefit_type": { "default": "percentage", "enum": [ "percentage", "fixed", "none" ], "title": "Benefit Type", "type": "string" }, "category_ids": { "items": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, "maxItems": 1000, "title": "Category Ids", "type": "array" }, "code": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{6,16}$", "type": "string" }, { "type": "null" } ], "title": "Code" }, "combine_coupons": { "default": false, "title": "Combine Coupons", "type": "boolean" }, "combine_promotions": { "default": false, "title": "Combine Promotions", "type": "boolean" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "$ref": "#/components/schemas/CreatorData" }, "customer_ids": { "items": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, "maxItems": 1000, "title": "Customer Ids", "type": "array" }, "enabled": { "title": "Enabled", "type": "boolean" }, "ends_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Ends At" }, "free_shipping": { "default": false, "title": "Free Shipping", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "kind": { "enum": [ "coupon", "promotion" ], "title": "Kind", "type": "string" }, "markets": { "items": { "$ref": "#/components/schemas/shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData" }, "maxItems": 1000, "minItems": 1, "title": "Markets", "type": "array" }, "minimum_quantity": { "default": 1, "maximum": 2147483647, "minimum": 1, "title": "Minimum Quantity", "type": "integer" }, "name": { "maxLength": 160, "minLength": 1, "title": "Name", "type": "string" }, "per_customer_limit": { "default": -1, "maximum": 2147483647, "minimum": -1, "title": "Per Customer Limit", "type": "integer" }, "percentage": { "default": "10", "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "title": "Percentage", "type": "string" }, "product_ids": { "items": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, "maxItems": 1000, "title": "Product Ids", "type": "array" }, "product_scope": { "default": "all", "enum": [ "all", "selected" ], "title": "Product Scope", "type": "string" }, "show_account": { "default": false, "title": "Show Account", "type": "boolean" }, "show_cart": { "default": false, "title": "Show Cart", "type": "boolean" }, "show_product": { "default": false, "title": "Show Product", "type": "boolean" }, "starts_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Starts At" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "usage_limit": { "default": -1, "maximum": 2147483647, "minimum": -1, "title": "Usage Limit", "type": "integer" }, "used_count": { "title": "Used Count", "type": "integer" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "name", "markets", "id", "kind", "enabled", "used_count", "version", "created_at", "updated_at", "created_by" ], "title": "CampaignData", "type": "object" }, "CampaignStatus": { "additionalProperties": false, "properties": { "enabled": { "title": "Enabled", "type": "boolean" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, "required": [ "expected_version", "enabled" ], "title": "CampaignStatus", "type": "object" }, "CampaignUpdate": { "additionalProperties": false, "properties": { "audience": { "default": "all", "enum": [ "all", "guest", "customer", "selected" ], "title": "Audience", "type": "string" }, "benefit_type": { "default": "percentage", "enum": [ "percentage", "fixed", "none" ], "title": "Benefit Type", "type": "string" }, "category_ids": { "items": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, "maxItems": 1000, "title": "Category Ids", "type": "array" }, "code": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{6,16}$", "type": "string" }, { "type": "null" } ], "title": "Code" }, "combine_coupons": { "default": false, "title": "Combine Coupons", "type": "boolean" }, "combine_promotions": { "default": false, "title": "Combine Promotions", "type": "boolean" }, "customer_ids": { "items": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, "maxItems": 1000, "title": "Customer Ids", "type": "array" }, "ends_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Ends At" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "free_shipping": { "default": false, "title": "Free Shipping", "type": "boolean" }, "markets": { "items": { "$ref": "#/components/schemas/MarketData-Input" }, "maxItems": 1000, "minItems": 1, "title": "Markets", "type": "array" }, "minimum_quantity": { "default": 1, "maximum": 2147483647, "minimum": 1, "title": "Minimum Quantity", "type": "integer" }, "name": { "maxLength": 160, "minLength": 1, "title": "Name", "type": "string" }, "per_customer_limit": { "default": -1, "maximum": 2147483647, "minimum": -1, "title": "Per Customer Limit", "type": "integer" }, "percentage": { "default": "10", "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "title": "Percentage", "type": "string" }, "product_ids": { "items": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, "maxItems": 1000, "title": "Product Ids", "type": "array" }, "product_scope": { "default": "all", "enum": [ "all", "selected" ], "title": "Product Scope", "type": "string" }, "show_account": { "default": false, "title": "Show Account", "type": "boolean" }, "show_cart": { "default": false, "title": "Show Cart", "type": "boolean" }, "show_product": { "default": false, "title": "Show Product", "type": "boolean" }, "starts_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Starts At" }, "usage_limit": { "default": -1, "maximum": 2147483647, "minimum": -1, "title": "Usage Limit", "type": "integer" } }, "required": [ "name", "markets", "expected_version" ], "title": "CampaignUpdate", "type": "object" }, "CategoryCreate": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 50000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "introduction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "type": "null" } ], "title": "Introduction" }, "is_visible": { "default": false, "title": "Is Visible", "type": "boolean" }, "market_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Market Ids", "type": "array" }, "meta_description": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Meta Description" }, "meta_keywords": { "anyOf": [ { "items": { "maxLength": 50, "type": "string" }, "maxItems": 20, "type": "array" }, { "type": "null" } ], "title": "Meta Keywords" }, "meta_title": { "anyOf": [ { "maxLength": 70, "type": "string" }, { "type": "null" } ], "title": "Meta Title" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "parent_id": { "anyOf": [ { "maxLength": 63, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "slug": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Slug" } }, "required": [ "name" ], "title": "CategoryCreate", "type": "object" }, "CategoryDetailData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "introduction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Introduction" }, "is_available": { "title": "Is Available", "type": "boolean" }, "is_visible": { "title": "Is Visible", "type": "boolean" }, "meta_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Meta Description" }, "meta_keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Meta Keywords" }, "meta_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Meta Title" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "number": { "title": "Number", "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "created_at", "updated_at", "parent_id", "name", "slug", "is_visible", "is_available", "version", "introduction", "description", "meta_title", "meta_description", "meta_keywords" ], "title": "CategoryDetailData", "type": "object" }, "CategorySummaryData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_available": { "title": "Is Available", "type": "boolean" }, "is_visible": { "title": "Is Visible", "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "number": { "title": "Number", "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "created_at", "updated_at", "parent_id", "name", "slug", "is_visible", "is_available", "version" ], "title": "CategorySummaryData", "type": "object" }, "CategoryUpdate": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 50000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "introduction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "type": "null" } ], "title": "Introduction" }, "is_visible": { "title": "Is Visible", "type": "boolean" }, "market_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Market Ids", "type": "array" }, "meta_description": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Meta Description" }, "meta_keywords": { "anyOf": [ { "items": { "maxLength": 50, "type": "string" }, "maxItems": 20, "type": "array" }, { "type": "null" } ], "title": "Meta Keywords" }, "meta_title": { "anyOf": [ { "maxLength": 70, "type": "string" }, { "type": "null" } ], "title": "Meta Title" }, "name": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Name" }, "parent_id": { "anyOf": [ { "maxLength": 63, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "slug": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Slug" } }, "required": [ "expected_version" ], "title": "CategoryUpdate", "type": "object" }, "ContextData": { "additionalProperties": false, "properties": { "base_market_id": { "title": "Base Market Id", "type": "string" }, "default_locale": { "title": "Default Locale", "type": "string" }, "global_enabled": { "title": "Global Enabled", "type": "boolean" }, "languages": { "items": { "$ref": "#/components/schemas/LanguageData" }, "title": "Languages", "type": "array" }, "markets": { "items": { "$ref": "#/components/schemas/shopently_engine__domains__global_commerce__adapters__public_http__context__schemas__MarketData" }, "title": "Markets", "type": "array" }, "multilingual_enabled": { "title": "Multilingual Enabled", "type": "boolean" } }, "required": [ "default_locale", "base_market_id", "multilingual_enabled", "global_enabled", "languages", "markets" ], "title": "ContextData", "type": "object" }, "ContextMeta": { "additionalProperties": false, "properties": { "locale": { "title": "Locale", "type": "string" }, "market_code": { "title": "Market Code", "type": "string" }, "market_id": { "title": "Market Id", "type": "string" }, "request_id": { "maxLength": 100, "minLength": 1, "title": "Request Id", "type": "string" } }, "required": [ "locale", "market_id", "market_code", "request_id" ], "title": "ContextMeta", "type": "object" }, "ContextPageMeta": { "additionalProperties": false, "properties": { "locale": { "title": "Locale", "type": "string" }, "market_code": { "title": "Market Code", "type": "string" }, "market_id": { "title": "Market Id", "type": "string" }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "request_id": { "maxLength": 100, "minLength": 1, "title": "Request Id", "type": "string" } }, "required": [ "locale", "market_id", "market_code", "request_id", "pagination" ], "title": "ContextPageMeta", "type": "object" }, "CreatorData": { "additionalProperties": false, "properties": { "kind": { "enum": [ "admin", "api" ], "title": "Kind", "type": "string" }, "label": { "title": "Label", "type": "string" }, "reference": { "title": "Reference", "type": "string" } }, "required": [ "kind", "reference", "label" ], "title": "CreatorData", "type": "object" }, "CurrencyData": { "additionalProperties": false, "properties": { "code": { "title": "Code", "type": "string" }, "minor_units": { "title": "Minor Units", "type": "integer" } }, "required": [ "code", "minor_units" ], "title": "CurrencyData", "type": "object" }, "CustomerData": { "additionalProperties": false, "properties": { "email": { "title": "Email", "type": "string" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" } }, "required": [ "first_name", "last_name", "email", "phone" ], "title": "CustomerData", "type": "object" }, "DeliveryCreate": { "additionalProperties": false, "properties": { "delivered_at": { "format": "date-time", "title": "Delivered At", "type": "string" }, "increases_stock": { "default": true, "title": "Increases Stock", "type": "boolean" }, "location_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Location Id", "type": "string" }, "notes": { "default": "", "maxLength": 2000, "title": "Notes", "type": "string" }, "quantity": { "maximum": 2147483647, "minimum": 1, "title": "Quantity", "type": "integer" }, "reason": { "default": "", "maxLength": 500, "title": "Reason", "type": "string" }, "status": { "enum": [ "planned", "received" ], "title": "Status", "type": "string" }, "target_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Target Id", "type": "string" }, "target_type": { "enum": [ "product", "variant" ], "title": "Target Type", "type": "string" }, "warehouse_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Warehouse Id", "type": "string" } }, "required": [ "target_type", "target_id", "warehouse_id", "location_id", "quantity", "delivered_at", "status" ], "title": "DeliveryCreate", "type": "object" }, "DeliveryData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "deleted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Deleted At" }, "delivered_at": { "format": "date-time", "title": "Delivered At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "increases_stock": { "title": "Increases Stock", "type": "boolean" }, "location_id": { "title": "Location Id", "type": "string" }, "quantity": { "title": "Quantity", "type": "integer" }, "received_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Received At" }, "record_status": { "enum": [ "active", "deleted" ], "title": "Record Status", "type": "string" }, "status": { "enum": [ "planned", "received" ], "title": "Status", "type": "string" }, "stock_applied_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Stock Applied At" }, "target_id": { "title": "Target Id", "type": "string" }, "target_type": { "enum": [ "product", "variant" ], "title": "Target Type", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "version": { "title": "Version", "type": "integer" }, "warehouse_id": { "title": "Warehouse Id", "type": "string" } }, "required": [ "id", "target_type", "target_id", "warehouse_id", "location_id", "quantity", "delivered_at", "status", "increases_stock", "stock_applied_at", "received_at", "record_status", "version", "created_at", "updated_at", "deleted_at" ], "title": "DeliveryData", "type": "object" }, "DeliveryDatesData": { "additionalProperties": false, "properties": { "dispatch_timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dispatch Timezone" }, "estimated_delivery_from": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Estimated Delivery From" }, "estimated_delivery_to": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Estimated Delivery To" }, "planned_dispatch_on": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Planned Dispatch On" } }, "required": [ "planned_dispatch_on", "dispatch_timezone", "estimated_delivery_from", "estimated_delivery_to" ], "title": "DeliveryDatesData", "type": "object" }, "DeliveryDetailData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "deleted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Deleted At" }, "delivered_at": { "format": "date-time", "title": "Delivered At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "increases_stock": { "title": "Increases Stock", "type": "boolean" }, "location_id": { "title": "Location Id", "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "quantity": { "title": "Quantity", "type": "integer" }, "received_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Received At" }, "record_status": { "enum": [ "active", "deleted" ], "title": "Record Status", "type": "string" }, "status": { "enum": [ "planned", "received" ], "title": "Status", "type": "string" }, "stock_applied_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Stock Applied At" }, "target_id": { "title": "Target Id", "type": "string" }, "target_type": { "enum": [ "product", "variant" ], "title": "Target Type", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "version": { "title": "Version", "type": "integer" }, "warehouse_id": { "title": "Warehouse Id", "type": "string" } }, "required": [ "id", "target_type", "target_id", "warehouse_id", "location_id", "quantity", "delivered_at", "status", "increases_stock", "stock_applied_at", "received_at", "record_status", "version", "created_at", "updated_at", "deleted_at", "notes" ], "title": "DeliveryDetailData", "type": "object" }, "DeliveryPickupPointData": { "additionalProperties": false, "properties": { "address": { "$ref": "#/components/schemas/PickupPointAddressData" }, "code": { "pattern": "^[A-Za-z0-9_-]{1,63}$", "title": "Code", "type": "string" }, "coordinates": { "anyOf": [ { "$ref": "#/components/schemas/PickupPointCoordinatesData" }, { "type": "null" } ] }, "country_code": { "pattern": "^[A-Z]{2}$", "title": "Country Code", "type": "string" }, "environment": { "enum": [ "live", "sandbox" ], "title": "Environment", "type": "string" }, "kind": { "enum": [ "locker", "pickup_point" ], "title": "Kind", "type": "string" }, "location_description": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ], "title": "Location Description" }, "name": { "maxLength": 160, "minLength": 1, "title": "Name", "type": "string" }, "opening_hours": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Opening Hours" }, "operator": { "maxLength": 63, "minLength": 1, "title": "Operator", "type": "string" }, "verified_at": { "format": "date-time", "title": "Verified At", "type": "string" } }, "required": [ "operator", "code", "kind", "country_code", "environment", "name", "address", "coordinates", "opening_hours", "location_description", "verified_at" ], "title": "DeliveryPickupPointData", "type": "object" }, "ErrorResponse": { "additionalProperties": false, "properties": { "error": { "$ref": "#/components/schemas/ApiError" }, "meta": { "$ref": "#/components/schemas/RequestMeta" } }, "required": [ "error", "meta" ], "title": "ErrorResponse", "type": "object" }, "FeatureCreate": { "additionalProperties": false, "properties": { "name": { "maxLength": 120, "minLength": 1, "pattern": "^[^\\x00]*$", "title": "Name", "type": "string" }, "position": { "maximum": 2147483647, "minimum": 0, "title": "Position", "type": "integer" } }, "required": [ "name" ], "title": "FeatureCreate", "type": "object" }, "FeatureData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "number": { "title": "Number", "type": "string" }, "position": { "title": "Position", "type": "integer" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "created_at", "updated_at", "name", "position", "version" ], "title": "FeatureData", "type": "object" }, "FeatureSelectionData": { "additionalProperties": false, "properties": { "feature_id": { "title": "Feature Id", "type": "string" }, "feature_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature Name" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "value_id": { "title": "Value Id", "type": "string" } }, "required": [ "feature_id", "feature_name", "value_id", "value" ], "title": "FeatureSelectionData", "type": "object" }, "FeatureUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "pattern": "^[^\\x00]*$", "type": "string" }, { "type": "null" } ], "title": "Name" }, "position": { "maximum": 2147483647, "minimum": 0, "title": "Position", "type": "integer" } }, "required": [ "expected_version" ], "title": "FeatureUpdate", "type": "object" }, "FeatureValueCreate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "position": { "maximum": 2147483647, "minimum": 0, "title": "Position", "type": "integer" }, "value": { "maxLength": 180, "minLength": 1, "pattern": "^[^\\x00]*$", "title": "Value", "type": "string" } }, "required": [ "value", "expected_version" ], "title": "FeatureValueCreate", "type": "object" }, "FeatureValueData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "feature_id": { "title": "Feature Id", "type": "string" }, "id": { "title": "Id", "type": "string" }, "number": { "title": "Number", "type": "string" }, "position": { "title": "Position", "type": "integer" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "created_at", "updated_at", "feature_id", "value", "position", "version" ], "title": "FeatureValueData", "type": "object" }, "FeatureValueUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "position": { "maximum": 2147483647, "minimum": 0, "title": "Position", "type": "integer" }, "value": { "anyOf": [ { "maxLength": 180, "minLength": 1, "pattern": "^[^\\x00]*$", "type": "string" }, { "type": "null" } ], "title": "Value" } }, "required": [ "expected_version" ], "title": "FeatureValueUpdate", "type": "object" }, "FieldError": { "additionalProperties": false, "properties": { "code": { "enum": [ "required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value" ], "title": "Code", "type": "string" }, "field": { "maxLength": 128, "minLength": 1, "title": "Field", "type": "string" }, "location": { "enum": [ "path", "query", "header", "body" ], "title": "Location", "type": "string" } }, "required": [ "location", "field", "code" ], "title": "FieldError", "type": "object" }, "InvoiceData": { "additionalProperties": false, "properties": { "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Line 1" }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Line 2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Name" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "house_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "House Number" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Street" }, "tax_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Identifier" }, "tax_scheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Scheme" } }, "required": [ "company_name", "tax_identifier", "tax_scheme", "country_code", "address_line_1", "address_line_2", "house_number", "street", "postal_code", "city", "region" ], "title": "InvoiceData", "type": "object" }, "LanguageData": { "additionalProperties": false, "properties": { "code": { "title": "Code", "type": "string" }, "direction": { "enum": [ "ltr", "rtl" ], "title": "Direction", "type": "string" }, "is_default": { "title": "Is Default", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "native_name": { "title": "Native Name", "type": "string" }, "status": { "enum": [ "draft", "published" ], "title": "Status", "type": "string" } }, "required": [ "code", "name", "native_name", "direction", "status", "is_default" ], "title": "LanguageData", "type": "object" }, "LocationData": { "additionalProperties": false, "properties": { "code": { "title": "Code", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_leaf": { "title": "Is Leaf", "type": "boolean" }, "location_type": { "enum": [ "zone", "rack", "shelf", "bin" ], "title": "Location Type", "type": "string" }, "name": { "title": "Name", "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" }, "warehouse_id": { "title": "Warehouse Id", "type": "string" } }, "required": [ "id", "warehouse_id", "code", "name", "parent_id", "location_type", "is_leaf", "version", "created_at", "updated_at" ], "title": "LocationData", "type": "object" }, "LocationQuantity": { "additionalProperties": false, "properties": { "location_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Location Id", "type": "string" }, "on_hand": { "maximum": 2147483647, "minimum": 0, "title": "On Hand", "type": "integer" } }, "required": [ "location_id", "on_hand" ], "title": "LocationQuantity", "type": "object" }, "ManualReservationUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "manual_reserved": { "maximum": 2147483647, "minimum": 0, "title": "Manual Reserved", "type": "integer" }, "reason": { "default": "", "maxLength": 500, "title": "Reason", "type": "string" } }, "required": [ "expected_version", "manual_reserved" ], "title": "ManualReservationUpdate", "type": "object" }, "MarketData-Input": { "additionalProperties": false, "properties": { "currency": { "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string" }, "fixed_amount": { "default": "0", "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "title": "Fixed Amount", "type": "string" }, "market_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Market Id", "type": "string" }, "maximum_price": { "anyOf": [ { "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "type": "string" }, { "type": "null" } ], "title": "Maximum Price" }, "minimum_price": { "anyOf": [ { "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "type": "string" }, { "type": "null" } ], "title": "Minimum Price" }, "minimum_subtotal": { "default": "0", "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "title": "Minimum Subtotal", "type": "string" }, "minor_units": { "maximum": 4, "minimum": 0, "title": "Minor Units", "type": "integer" } }, "required": [ "market_id", "currency", "minor_units" ], "title": "MarketData", "type": "object" }, "MetricData": { "additionalProperties": false, "properties": { "clicks": { "title": "Clicks", "type": "integer" }, "last_seen_at": { "format": "date-time", "title": "Last Seen At", "type": "string" }, "query_display": { "title": "Query Display", "type": "string" }, "query_hash": { "title": "Query Hash", "type": "string" }, "searches": { "title": "Searches", "type": "integer" }, "zero_results": { "title": "Zero Results", "type": "integer" } }, "required": [ "query_display", "query_hash", "searches", "zero_results", "clicks", "last_seen_at" ], "title": "MetricData", "type": "object" }, "MoneyData": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency": { "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string" }, "minor_units": { "maximum": 4, "minimum": 0, "title": "Minor Units", "type": "integer" } }, "required": [ "amount", "currency", "minor_units" ], "title": "MoneyData", "type": "object" }, "MutationData": { "additionalProperties": false, "properties": { "deleted": { "title": "Deleted", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "required": [ "id", "version", "deleted" ], "title": "MutationData", "type": "object" }, "OccurrenceData": { "additionalProperties": false, "properties": { "category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Id" }, "category_result_count": { "title": "Category Result Count", "type": "integer" }, "currency_code": { "title": "Currency Code", "type": "string" }, "is_zero_results": { "title": "Is Zero Results", "type": "boolean" }, "locale_code": { "title": "Locale Code", "type": "string" }, "market_id": { "title": "Market Id", "type": "string" }, "max_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Max Price" }, "min_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Min Price" }, "occurred_at": { "format": "date-time", "title": "Occurred At", "type": "string" }, "page": { "title": "Page", "type": "integer" }, "product_result_count": { "title": "Product Result Count", "type": "integer" }, "query_display": { "title": "Query Display", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResultSnapshotData" }, "type": "array" }, { "type": "null" } ], "title": "Results" }, "sort_key": { "title": "Sort Key", "type": "string" }, "source": { "enum": [ "results", "autocomplete" ], "title": "Source", "type": "string" } }, "required": [ "request_id", "occurred_at", "source", "locale_code", "market_id", "currency_code", "query_display", "category_id", "min_price", "max_price", "sort_key", "page", "product_result_count", "category_result_count", "is_zero_results", "results" ], "title": "OccurrenceData", "type": "object" }, "OrderAmountBreakdownData": { "additionalProperties": false, "properties": { "gross": { "$ref": "#/components/schemas/MoneyData" }, "net": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] } }, "required": [ "net", "tax", "gross" ], "title": "OrderAmountBreakdownData", "type": "object" }, "OrderDeliveryDiscountData": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/MoneyData" }, "campaign_id": { "title": "Campaign Id", "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "kind": { "enum": [ "coupon", "promotion" ], "title": "Kind", "type": "string" }, "name": { "title": "Name", "type": "string" }, "sequence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "campaign_id", "version", "kind", "name", "code", "sequence", "amount" ], "title": "OrderDeliveryDiscountData", "type": "object" }, "OrderDetailData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "customer": { "$ref": "#/components/schemas/CustomerData" }, "delivery": { "$ref": "#/components/schemas/ShippingDetailData" }, "discount_amount": { "$ref": "#/components/schemas/MoneyData" }, "discounts": { "items": { "$ref": "#/components/schemas/OrderDiscountData" }, "title": "Discounts", "type": "array" }, "id": { "title": "Id", "type": "string" }, "invoice": { "anyOf": [ { "$ref": "#/components/schemas/InvoiceData" }, { "type": "null" } ] }, "invoice_requested": { "title": "Invoice Requested", "type": "boolean" }, "lifecycle_state": { "$ref": "#/components/schemas/OrderLifecycleState" }, "lines": { "items": { "$ref": "#/components/schemas/OrderLineData" }, "title": "Lines", "type": "array" }, "locale": { "title": "Locale", "type": "string" }, "market_id": { "title": "Market Id", "type": "string" }, "number": { "title": "Number", "type": "string" }, "payment": { "$ref": "#/components/schemas/PaymentData" }, "pickup_point": { "anyOf": [ { "$ref": "#/components/schemas/PickupPointData" }, { "type": "null" } ] }, "prices_include_tax": { "title": "Prices Include Tax", "type": "boolean" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/AddressData" }, { "type": "null" } ] }, "shipping_discount_amount": { "$ref": "#/components/schemas/MoneyData" }, "status": { "$ref": "#/components/schemas/OrderStatusData" }, "subtotal": { "$ref": "#/components/schemas/MoneyData" }, "tax": { "$ref": "#/components/schemas/MoneyData" }, "tax_breakdown": { "$ref": "#/components/schemas/OrderTaxBreakdownData" }, "tax_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Country Code" }, "total": { "$ref": "#/components/schemas/MoneyData" }, "totals": { "$ref": "#/components/schemas/OrderTotalsData" } }, "required": [ "id", "number", "created_at", "lifecycle_state", "status", "payment", "customer", "delivery", "total", "subtotal", "tax", "market_id", "locale", "prices_include_tax", "tax_country_code", "discount_amount", "shipping_discount_amount", "totals", "tax_breakdown", "pickup_point", "shipping_address", "invoice_requested", "invoice", "lines", "discounts" ], "title": "OrderDetailData", "type": "object" }, "OrderDiscountData": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/MoneyData" }, "campaign_id": { "title": "Campaign Id", "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "kind": { "enum": [ "coupon", "promotion" ], "title": "Kind", "type": "string" }, "name": { "title": "Name", "type": "string" }, "sequence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence" }, "shipping_amount": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "version": { "title": "Version", "type": "integer" } }, "required": [ "campaign_id", "version", "kind", "name", "code", "amount" ], "title": "OrderDiscountData", "type": "object" }, "OrderImageData": { "additionalProperties": false, "properties": { "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alt" }, "source": { "const": "current_catalog", "default": "current_catalog", "title": "Source", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "url", "alt" ], "title": "OrderImageData", "type": "object" }, "OrderLifecycleState": { "enum": [ "placed", "cancelled", "fulfilled", "returned" ], "title": "OrderLifecycleState", "type": "string" }, "OrderLineData": { "additionalProperties": false, "properties": { "discount_amount": { "$ref": "#/components/schemas/MoneyData" }, "discount_gross": { "$ref": "#/components/schemas/MoneyData" }, "discount_net": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "discount_tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "discounts": { "items": { "$ref": "#/components/schemas/OrderDiscountData" }, "title": "Discounts", "type": "array" }, "identifiers": { "additionalProperties": { "type": "string" }, "title": "Identifiers", "type": "object" }, "image": { "anyOf": [ { "$ref": "#/components/schemas/OrderImageData" }, { "type": "null" } ] }, "line_id": { "title": "Line Id", "type": "string" }, "manual_discount": { "anyOf": [ { "$ref": "#/components/schemas/OrderManualDiscountData" }, { "type": "null" } ] }, "name": { "title": "Name", "type": "string" }, "original_total": { "$ref": "#/components/schemas/MoneyData" }, "original_total_gross": { "$ref": "#/components/schemas/MoneyData" }, "original_total_net": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "original_total_tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "position": { "title": "Position", "type": "integer" }, "product_id": { "title": "Product Id", "type": "string" }, "quantity": { "title": "Quantity", "type": "integer" }, "sku": { "title": "Sku", "type": "string" }, "tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "tax_category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Category Id" }, "tax_category_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Category Name" }, "tax_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Rate" }, "total": { "$ref": "#/components/schemas/MoneyData" }, "total_gross": { "$ref": "#/components/schemas/MoneyData" }, "total_net": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "total_tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "unit_gross": { "$ref": "#/components/schemas/MoneyData" }, "unit_net": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "unit_price": { "$ref": "#/components/schemas/MoneyData" }, "unit_tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "variant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Id" }, "variant_options": { "items": { "$ref": "#/components/schemas/shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData" }, "title": "Variant Options", "type": "array" } }, "required": [ "line_id", "tax_rate", "tax_category_id", "tax_category_name", "unit_net", "unit_tax", "unit_gross", "original_total_net", "original_total_tax", "original_total_gross", "discount_net", "discount_tax", "discount_gross", "total_net", "total_gross", "manual_discount", "position", "product_id", "variant_id", "name", "sku", "identifiers", "variant_options", "quantity", "unit_price", "total", "tax", "image", "original_total", "discount_amount", "discounts", "total_tax" ], "title": "OrderLineData", "type": "object" }, "OrderManualDiscountData": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/MoneyData" }, "kind": { "enum": [ "percentage", "fixed" ], "title": "Kind", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "kind", "value", "amount" ], "title": "OrderManualDiscountData", "type": "object" }, "OrderPaymentStatus": { "enum": [ "unpaid", "paid", "failed", "refunded" ], "title": "OrderPaymentStatus", "type": "string" }, "OrderStatusData": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "id", "name", "updated_at" ], "title": "OrderStatusData", "type": "object" }, "OrderStatusUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "status_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Status Id", "type": "string" } }, "required": [ "status_id", "expected_version" ], "title": "OrderStatusUpdate", "type": "object" }, "OrderSummaryData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "customer": { "$ref": "#/components/schemas/CustomerData" }, "delivery": { "$ref": "#/components/schemas/ShippingData" }, "discount_amount": { "$ref": "#/components/schemas/MoneyData" }, "id": { "title": "Id", "type": "string" }, "lifecycle_state": { "$ref": "#/components/schemas/OrderLifecycleState" }, "locale": { "title": "Locale", "type": "string" }, "market_id": { "title": "Market Id", "type": "string" }, "number": { "title": "Number", "type": "string" }, "payment": { "$ref": "#/components/schemas/PaymentData" }, "prices_include_tax": { "title": "Prices Include Tax", "type": "boolean" }, "shipping_discount_amount": { "$ref": "#/components/schemas/MoneyData" }, "status": { "$ref": "#/components/schemas/OrderStatusData" }, "subtotal": { "$ref": "#/components/schemas/MoneyData" }, "tax": { "$ref": "#/components/schemas/MoneyData" }, "tax_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Country Code" }, "total": { "$ref": "#/components/schemas/MoneyData" } }, "required": [ "id", "number", "created_at", "lifecycle_state", "status", "payment", "customer", "delivery", "total", "subtotal", "tax", "market_id", "locale", "prices_include_tax", "tax_country_code", "discount_amount", "shipping_discount_amount" ], "title": "OrderSummaryData", "type": "object" }, "OrderTaxBreakdownData": { "additionalProperties": false, "properties": { "groups": { "items": { "$ref": "#/components/schemas/OrderTaxGroupData" }, "title": "Groups", "type": "array" }, "unallocated_tax": { "$ref": "#/components/schemas/MoneyData" } }, "required": [ "groups", "unallocated_tax" ], "title": "OrderTaxBreakdownData", "type": "object" }, "OrderTaxGroupData": { "additionalProperties": false, "properties": { "gross": { "$ref": "#/components/schemas/MoneyData" }, "net": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "source": { "enum": [ "products", "shipping" ], "title": "Source", "type": "string" }, "tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "tax_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Rate" } }, "required": [ "source", "tax_rate", "net", "tax", "gross" ], "title": "OrderTaxGroupData", "type": "object" }, "OrderTotalsData": { "additionalProperties": false, "properties": { "before_discounts": { "$ref": "#/components/schemas/OrderAmountBreakdownData" }, "discounts": { "$ref": "#/components/schemas/OrderAmountBreakdownData" }, "order": { "$ref": "#/components/schemas/OrderAmountBreakdownData" }, "product_discounts": { "$ref": "#/components/schemas/OrderAmountBreakdownData" }, "products": { "$ref": "#/components/schemas/OrderAmountBreakdownData" }, "products_before_discounts": { "$ref": "#/components/schemas/OrderAmountBreakdownData" }, "shipping": { "$ref": "#/components/schemas/OrderAmountBreakdownData" }, "shipping_before_discounts": { "$ref": "#/components/schemas/OrderAmountBreakdownData" }, "shipping_discounts": { "$ref": "#/components/schemas/OrderAmountBreakdownData" } }, "required": [ "products_before_discounts", "product_discounts", "products", "shipping_before_discounts", "shipping_discounts", "shipping", "discounts", "order", "before_discounts" ], "title": "OrderTotalsData", "type": "object" }, "OverviewData": { "additionalProperties": false, "properties": { "click_through_rate": { "title": "Click Through Rate", "type": "number" }, "clicked_searches": { "title": "Clicked Searches", "type": "integer" }, "recent": { "items": { "$ref": "#/components/schemas/RecentSearchData" }, "title": "Recent", "type": "array" }, "searches": { "title": "Searches", "type": "integer" }, "zero_result_rate": { "title": "Zero Result Rate", "type": "number" }, "zero_results": { "title": "Zero Results", "type": "integer" } }, "required": [ "searches", "zero_results", "clicked_searches", "zero_result_rate", "click_through_rate", "recent" ], "title": "OverviewData", "type": "object" }, "PageCreate": { "additionalProperties": false, "properties": { "body_html": { "anyOf": [ { "maxLength": 100000, "type": "string" }, { "type": "null" } ], "title": "Body Html" }, "market_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Market Ids", "type": "array" }, "market_scope": { "enum": [ "all", "selected" ], "title": "Market Scope", "type": "string" }, "meta_description": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Meta Description" }, "meta_keywords": { "anyOf": [ { "items": { "maxLength": 60, "type": "string" }, "maxItems": 20, "type": "array" }, { "type": "null" } ], "title": "Meta Keywords" }, "meta_title": { "anyOf": [ { "maxLength": 70, "type": "string" }, { "type": "null" } ], "title": "Meta Title" }, "published": { "default": false, "title": "Published", "type": "boolean" }, "slug": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Slug" }, "title": { "maxLength": 300, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "PageCreate", "type": "object" }, "PageDetailData": { "additionalProperties": false, "properties": { "body_html": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body Html" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_available": { "title": "Is Available", "type": "boolean" }, "market_scope": { "enum": [ "all", "selected" ], "title": "Market Scope", "type": "string" }, "meta_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Meta Description" }, "meta_keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Meta Keywords" }, "meta_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Meta Title" }, "number": { "title": "Number", "type": "string" }, "published": { "title": "Published", "type": "boolean" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "version", "created_at", "updated_at", "published", "title", "slug", "market_scope", "is_available", "body_html", "meta_title", "meta_description", "meta_keywords" ], "title": "PageDetailData", "type": "object" }, "PageMeta": { "additionalProperties": false, "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "request_id": { "maxLength": 100, "minLength": 1, "title": "Request Id", "type": "string" } }, "required": [ "request_id", "pagination" ], "title": "PageMeta", "type": "object" }, "PageSummaryData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_available": { "title": "Is Available", "type": "boolean" }, "market_scope": { "enum": [ "all", "selected" ], "title": "Market Scope", "type": "string" }, "number": { "title": "Number", "type": "string" }, "published": { "title": "Published", "type": "boolean" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "version", "created_at", "updated_at", "published", "title", "slug", "market_scope", "is_available" ], "title": "PageSummaryData", "type": "object" }, "PageUpdate": { "additionalProperties": false, "properties": { "body_html": { "anyOf": [ { "maxLength": 100000, "type": "string" }, { "type": "null" } ], "title": "Body Html" }, "expected_version": { "maximum": 2147483647, "minimum": 1, "title": "Expected Version", "type": "integer" }, "market_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Market Ids", "type": "array" }, "market_scope": { "enum": [ "all", "selected" ], "title": "Market Scope", "type": "string" }, "meta_description": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Meta Description" }, "meta_keywords": { "anyOf": [ { "items": { "maxLength": 60, "type": "string" }, "maxItems": 20, "type": "array" }, { "type": "null" } ], "title": "Meta Keywords" }, "meta_title": { "anyOf": [ { "maxLength": 70, "type": "string" }, { "type": "null" } ], "title": "Meta Title" }, "published": { "title": "Published", "type": "boolean" }, "slug": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Slug" }, "title": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "expected_version" ], "title": "PageUpdate", "type": "object" }, "Pagination": { "additionalProperties": false, "properties": { "has_more": { "title": "Has More", "type": "boolean" }, "limit": { "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "limit", "next_cursor", "has_more" ], "title": "Pagination", "type": "object" }, "PaymentData": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/MoneyData" }, "environment": { "enum": [ "live", "sandbox" ], "title": "Environment", "type": "string" }, "method_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method Code" }, "method_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method Name" }, "paid_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Paid At" }, "status": { "$ref": "#/components/schemas/OrderPaymentStatus" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "status", "version", "updated_at", "paid_at", "method_code", "method_name", "environment", "amount" ], "title": "PaymentData", "type": "object" }, "PaymentStatus": { "enum": [ "unpaid", "paid", "failed", "refunded" ], "title": "PaymentStatus", "type": "string" }, "PaymentStatusUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 0, "title": "Expected Version", "type": "integer" }, "reason": { "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string" }, "status": { "$ref": "#/components/schemas/PaymentStatus" } }, "required": [ "status", "expected_version", "reason" ], "title": "PaymentStatusUpdate", "type": "object" }, "PickupPointAddressData": { "additionalProperties": false, "properties": { "address_line_1": { "maxLength": 240, "minLength": 1, "title": "Address Line 1", "type": "string" }, "city": { "maxLength": 160, "minLength": 1, "title": "City", "type": "string" }, "postal_code": { "maxLength": 32, "minLength": 1, "title": "Postal Code", "type": "string" } }, "required": [ "address_line_1", "postal_code", "city" ], "title": "PickupPointAddressData", "type": "object" }, "PickupPointCoordinatesData": { "additionalProperties": false, "properties": { "latitude": { "maximum": 90.0, "minimum": -90.0, "title": "Latitude", "type": "number" }, "longitude": { "maximum": 180.0, "minimum": -180.0, "title": "Longitude", "type": "number" } }, "required": [ "latitude", "longitude" ], "title": "PickupPointCoordinatesData", "type": "object" }, "PickupPointData": { "additionalProperties": false, "properties": { "address_line1": { "title": "Address Line1", "type": "string" }, "city": { "title": "City", "type": "string" }, "code": { "title": "Code", "type": "string" }, "country_code": { "title": "Country Code", "type": "string" }, "kind": { "enum": [ "locker", "pickup_point" ], "title": "Kind", "type": "string" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude" }, "location_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Description" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude" }, "name": { "title": "Name", "type": "string" }, "opening_hours": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Opening Hours" }, "operator": { "title": "Operator", "type": "string" }, "postal_code": { "title": "Postal Code", "type": "string" } }, "required": [ "operator", "code", "kind", "name", "address_line1", "postal_code", "city", "country_code", "latitude", "longitude", "opening_hours", "location_description" ], "title": "PickupPointData", "type": "object" }, "PickupPointSummaryData": { "additionalProperties": false, "properties": { "code": { "pattern": "^[A-Za-z0-9_-]{1,63}$", "title": "Code", "type": "string" }, "country_code": { "pattern": "^[A-Z]{2}$", "title": "Country Code", "type": "string" }, "environment": { "enum": [ "live", "sandbox" ], "title": "Environment", "type": "string" }, "kind": { "enum": [ "locker", "pickup_point" ], "title": "Kind", "type": "string" }, "operator": { "maxLength": 63, "minLength": 1, "title": "Operator", "type": "string" } }, "required": [ "operator", "code", "kind", "country_code", "environment" ], "title": "PickupPointSummaryData", "type": "object" }, "PriceData": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency": { "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string" }, "minor_units": { "maximum": 4, "minimum": 0, "title": "Minor Units", "type": "integer" }, "tax_included": { "title": "Tax Included", "type": "boolean" } }, "required": [ "amount", "currency", "minor_units", "tax_included" ], "title": "PriceData", "type": "object" }, "PriceListData": { "additionalProperties": false, "properties": { "currency": { "title": "Currency", "type": "string" }, "id": { "title": "Id", "type": "string" }, "tax_included": { "title": "Tax Included", "type": "boolean" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "version", "currency", "tax_included" ], "title": "PriceListData", "type": "object" }, "ProductCreate": { "additionalProperties": false, "properties": { "brand_id": { "anyOf": [ { "maxLength": 63, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Brand Id" }, "condition": { "default": "new", "enum": [ "new", "refurbished", "used", "returned", "display", "damaged" ], "title": "Condition", "type": "string" }, "description": { "anyOf": [ { "maxLength": 100000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "feature_value_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Feature Value Ids", "type": "array" }, "identifiers": { "anyOf": [ { "$ref": "#/components/schemas/ProductIdentifiers" }, { "type": "null" } ] }, "market_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Market Ids", "type": "array" }, "media_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Media Ids", "type": "array" }, "meta_description": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Meta Description" }, "meta_keywords": { "anyOf": [ { "items": { "maxLength": 50, "type": "string" }, "maxItems": 20, "type": "array" }, { "type": "null" } ], "title": "Meta Keywords" }, "meta_title": { "anyOf": [ { "maxLength": 70, "type": "string" }, { "type": "null" } ], "title": "Meta Title" }, "name": { "maxLength": 300, "minLength": 1, "title": "Name", "type": "string" }, "pricing": { "$ref": "#/components/schemas/ProductPrice", "title": "Pricing" }, "primary_category_id": { "anyOf": [ { "maxLength": 63, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Primary Category Id" }, "published": { "default": false, "title": "Published", "type": "boolean" }, "sku": { "maxLength": 100, "minLength": 1, "pattern": "^\\S+$", "title": "Sku", "type": "string" }, "slug": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Slug" }, "tax_category_id": { "anyOf": [ { "maxLength": 63, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Tax Category Id" }, "variant_value_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 250, "title": "Variant Value Ids", "type": "array" }, "variants_enabled": { "default": false, "title": "Variants Enabled", "type": "boolean" } }, "required": [ "name", "sku" ], "title": "ProductCreate", "type": "object" }, "ProductDetailData": { "additionalProperties": false, "properties": { "availability": { "$ref": "#/components/schemas/AvailabilityData" }, "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brand Id" }, "condition": { "enum": [ "new", "refurbished", "used", "returned", "display", "damaged" ], "title": "Condition", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "features": { "items": { "$ref": "#/components/schemas/FeatureSelectionData" }, "title": "Features", "type": "array" }, "id": { "title": "Id", "type": "string" }, "identifiers": { "additionalProperties": { "type": "string" }, "title": "Identifiers", "type": "object" }, "media": { "items": { "$ref": "#/components/schemas/ProductMediaData" }, "title": "Media", "type": "array" }, "meta_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Meta Description" }, "meta_keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Meta Keywords" }, "meta_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Meta Title" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "number": { "title": "Number", "type": "string" }, "price": { "anyOf": [ { "$ref": "#/components/schemas/PriceData" }, { "type": "null" } ] }, "price_version": { "title": "Price Version", "type": "integer" }, "primary_category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Category Id" }, "primary_media_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Media Id" }, "published": { "title": "Published", "type": "boolean" }, "sku": { "title": "Sku", "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "tax_category_id": { "title": "Tax Category Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "variants_enabled": { "title": "Variants Enabled", "type": "boolean" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "version", "price_version", "created_at", "updated_at", "name", "slug", "sku", "published", "condition", "brand_id", "primary_category_id", "tax_category_id", "variants_enabled", "primary_media_id", "availability", "price", "description", "meta_title", "meta_description", "meta_keywords", "identifiers", "media", "features" ], "title": "ProductDetailData", "type": "object" }, "ProductIdentifiers": { "additionalProperties": false, "properties": { "ean": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Ean" }, "isbn": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Isbn" }, "mpn": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Mpn" }, "upc": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Upc" } }, "title": "ProductIdentifiers", "type": "object" }, "ProductMediaData": { "additionalProperties": false, "properties": { "alt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alt Text" }, "id": { "title": "Id", "type": "string" }, "is_primary": { "title": "Is Primary", "type": "boolean" }, "kind": { "enum": [ "image", "video", "model_3d" ], "title": "Kind", "type": "string" }, "mime_type": { "title": "Mime Type", "type": "string" }, "position": { "title": "Position", "type": "integer" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "required": [ "id", "position", "is_primary", "kind", "mime_type", "alt_text", "url" ], "title": "ProductMediaData", "type": "object" }, "ProductPrice": { "additionalProperties": false, "properties": { "amount": { "anyOf": [ { "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "type": "string" }, { "type": "null" } ], "title": "Amount" }, "currency": { "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string" }, "expected_price_list_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Price List Version", "type": "integer" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 0, "title": "Expected Version", "type": "integer" }, "kind": { "enum": [ "base", "market_fixed" ], "title": "Kind", "type": "string" }, "price_list_id": { "maxLength": 63, "minLength": 1, "title": "Price List Id", "type": "string" }, "tax_included": { "title": "Tax Included", "type": "boolean" } }, "required": [ "kind", "amount", "currency", "price_list_id", "expected_price_list_version", "expected_version", "tax_included" ], "title": "ProductPrice", "type": "object" }, "ProductSummaryData": { "additionalProperties": false, "properties": { "availability": { "$ref": "#/components/schemas/AvailabilityData" }, "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brand Id" }, "condition": { "enum": [ "new", "refurbished", "used", "returned", "display", "damaged" ], "title": "Condition", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "number": { "title": "Number", "type": "string" }, "price": { "anyOf": [ { "$ref": "#/components/schemas/PriceData" }, { "type": "null" } ] }, "price_version": { "title": "Price Version", "type": "integer" }, "primary_category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Category Id" }, "primary_media_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Media Id" }, "published": { "title": "Published", "type": "boolean" }, "sku": { "title": "Sku", "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "tax_category_id": { "title": "Tax Category Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "variants_enabled": { "title": "Variants Enabled", "type": "boolean" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "version", "price_version", "created_at", "updated_at", "name", "slug", "sku", "published", "condition", "brand_id", "primary_category_id", "tax_category_id", "variants_enabled", "primary_media_id", "availability", "price" ], "title": "ProductSummaryData", "type": "object" }, "ProductUpdate": { "additionalProperties": false, "properties": { "brand_id": { "anyOf": [ { "maxLength": 63, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Brand Id" }, "condition": { "enum": [ "new", "refurbished", "used", "returned", "display", "damaged" ], "title": "Condition", "type": "string" }, "description": { "anyOf": [ { "maxLength": 100000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "expected_variant_price_versions": { "additionalProperties": { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, "maxProperties": 250, "propertyNames": { "maxLength": 63, "minLength": 1 }, "title": "Expected Variant Price Versions", "type": "object" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "feature_value_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Feature Value Ids", "type": "array" }, "identifiers": { "anyOf": [ { "$ref": "#/components/schemas/ProductIdentifiers" }, { "type": "null" } ] }, "market_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Market Ids", "type": "array" }, "media_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Media Ids", "type": "array" }, "meta_description": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Meta Description" }, "meta_keywords": { "anyOf": [ { "items": { "maxLength": 50, "type": "string" }, "maxItems": 20, "type": "array" }, { "type": "null" } ], "title": "Meta Keywords" }, "meta_title": { "anyOf": [ { "maxLength": 70, "type": "string" }, { "type": "null" } ], "title": "Meta Title" }, "name": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "title": "Name" }, "pricing": { "$ref": "#/components/schemas/ProductPrice", "title": "Pricing" }, "primary_category_id": { "anyOf": [ { "maxLength": 63, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Primary Category Id" }, "published": { "title": "Published", "type": "boolean" }, "sku": { "maxLength": 100, "minLength": 1, "pattern": "^\\S+$", "title": "Sku", "type": "string" }, "slug": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Slug" }, "tax_category_id": { "anyOf": [ { "maxLength": 63, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Tax Category Id" }, "variant_value_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 250, "title": "Variant Value Ids", "type": "array" }, "variants_enabled": { "title": "Variants Enabled", "type": "boolean" } }, "required": [ "expected_version" ], "title": "ProductUpdate", "type": "object" }, "ProductVariantData": { "additionalProperties": false, "properties": { "active": { "title": "Active", "type": "boolean" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_default": { "title": "Is Default", "type": "boolean" }, "media_ids": { "items": { "type": "string" }, "title": "Media Ids", "type": "array" }, "position": { "title": "Position", "type": "integer" }, "pricing": { "$ref": "#/components/schemas/VariantPricingData" }, "primary_media_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Media Id" }, "product_id": { "title": "Product Id", "type": "string" }, "sku": { "title": "Sku", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "values": { "items": { "$ref": "#/components/schemas/VariantChoiceData" }, "title": "Values", "type": "array" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "product_id", "version", "created_at", "updated_at", "sku", "active", "is_default", "position", "values", "media_ids", "primary_media_id", "pricing" ], "title": "ProductVariantData", "type": "object" }, "QueryMetricSort": { "enum": [ "last_seen_desc", "last_seen_asc", "searches_desc", "searches_asc", "clicks_desc", "clicks_asc" ], "title": "QueryMetricSort", "type": "string" }, "RecentSearchData": { "additionalProperties": false, "properties": { "is_zero_results": { "title": "Is Zero Results", "type": "boolean" }, "locale_code": { "title": "Locale Code", "type": "string" }, "occurred_at": { "format": "date-time", "title": "Occurred At", "type": "string" }, "query_display": { "title": "Query Display", "type": "string" }, "query_hash": { "title": "Query Hash", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "result_count": { "title": "Result Count", "type": "integer" }, "source": { "enum": [ "results", "autocomplete" ], "title": "Source", "type": "string" } }, "required": [ "request_id", "query_display", "query_hash", "occurred_at", "locale_code", "source", "result_count", "is_zero_results" ], "title": "RecentSearchData", "type": "object" }, "RefundAmountUpdate": { "additionalProperties": false, "properties": { "amount": { "maxLength": 64, "minLength": 1, "pattern": "^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$", "title": "Amount", "type": "string" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 0, "title": "Expected Version", "type": "integer" }, "reason": { "default": "", "maxLength": 500, "title": "Reason", "type": "string" } }, "required": [ "amount", "expected_version" ], "title": "RefundAmountUpdate", "type": "object" }, "RefundData": { "additionalProperties": false, "properties": { "amount": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "status": { "enum": [ "pending", "completed" ], "title": "Status", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "amount", "status", "version", "updated_at", "completed_at" ], "title": "RefundData", "type": "object" }, "RequestCustomerData": { "additionalProperties": false, "properties": { "email": { "title": "Email", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name", "email" ], "title": "RequestCustomerData", "type": "object" }, "RequestDetailData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "customer": { "$ref": "#/components/schemas/RequestCustomerData" }, "id": { "title": "Id", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/RequestItemData" }, "title": "Items", "type": "array" }, "number": { "title": "Number", "type": "string" }, "order_id": { "title": "Order Id", "type": "string" }, "order_number": { "title": "Order Number", "type": "string" }, "products_value": { "$ref": "#/components/schemas/MoneyData" }, "refund": { "$ref": "#/components/schemas/RefundData" }, "resolution_state": { "enum": [ "unknown", "open", "completed", "rejected", "cancelled" ], "title": "Resolution State", "type": "string" }, "status": { "$ref": "#/components/schemas/RequestStatusData" }, "type": { "$ref": "#/components/schemas/RequestType" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "type", "order_id", "order_number", "created_at", "updated_at", "version", "resolution_state", "customer", "status", "products_value", "refund", "items" ], "title": "RequestDetailData", "type": "object" }, "RequestItemData": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "order_line_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Line Id" }, "product_id": { "title": "Product Id", "type": "string" }, "quantity": { "title": "Quantity", "type": "integer" }, "returned_quantity": { "title": "Returned Quantity", "type": "integer" }, "sku": { "title": "Sku", "type": "string" }, "total": { "$ref": "#/components/schemas/MoneyData" }, "unit_price": { "$ref": "#/components/schemas/MoneyData" }, "variant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Id" }, "variant_options": { "items": { "$ref": "#/components/schemas/shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData" }, "title": "Variant Options", "type": "array" } }, "required": [ "id", "order_line_id", "product_id", "variant_id", "name", "sku", "quantity", "returned_quantity", "unit_price", "total", "variant_options" ], "title": "RequestItemData", "type": "object" }, "RequestMeta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "title": "Request Id", "type": "string" } }, "required": [ "request_id" ], "title": "RequestMeta", "type": "object" }, "RequestStatusData": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "locale": { "title": "Locale", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "required": [ "id", "name", "locale" ], "title": "RequestStatusData", "type": "object" }, "RequestStatusUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "status_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Status Id", "type": "string" } }, "required": [ "status_id", "expected_version" ], "title": "RequestStatusUpdate", "type": "object" }, "RequestSummaryData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "customer": { "$ref": "#/components/schemas/RequestCustomerData" }, "id": { "title": "Id", "type": "string" }, "number": { "title": "Number", "type": "string" }, "order_id": { "title": "Order Id", "type": "string" }, "order_number": { "title": "Order Number", "type": "string" }, "products_value": { "$ref": "#/components/schemas/MoneyData" }, "refund": { "$ref": "#/components/schemas/RefundData" }, "resolution_state": { "enum": [ "unknown", "open", "completed", "rejected", "cancelled" ], "title": "Resolution State", "type": "string" }, "status": { "$ref": "#/components/schemas/RequestStatusData" }, "type": { "$ref": "#/components/schemas/RequestType" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "type", "order_id", "order_number", "created_at", "updated_at", "version", "resolution_state", "customer", "status", "products_value", "refund" ], "title": "RequestSummaryData", "type": "object" }, "RequestType": { "enum": [ "return", "exchange", "complaint" ], "title": "RequestType", "type": "string" }, "ResultSnapshotData": { "additionalProperties": false, "properties": { "clicked": { "title": "Clicked", "type": "boolean" }, "entity_id": { "title": "Entity Id", "type": "string" }, "entity_type": { "enum": [ "product", "category" ], "title": "Entity Type", "type": "string" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Number" }, "placement_source": { "enum": [ "organic", "merchandising" ], "title": "Placement Source", "type": "string" }, "position": { "title": "Position", "type": "integer" }, "sku": { "title": "Sku", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "title": { "title": "Title", "type": "string" } }, "required": [ "entity_type", "entity_id", "position", "title", "number", "slug", "sku", "image_url", "placement_source", "clicked" ], "title": "ResultSnapshotData", "type": "object" }, "RuleCreate": { "additionalProperties": false, "properties": { "category_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 100, "title": "Category Ids", "type": "array" }, "enabled": { "default": false, "title": "Enabled", "type": "boolean" }, "market_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Market Ids", "type": "array" }, "market_scope": { "enum": [ "all", "selected" ], "title": "Market Scope", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "title": "Name", "type": "string" }, "phrases": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 20, "minItems": 1, "title": "Phrases", "type": "array" }, "product_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 100, "title": "Product Ids", "type": "array" } }, "required": [ "name", "phrases" ], "title": "RuleCreate", "type": "object" }, "RuleDetailData": { "additionalProperties": false, "properties": { "category_ids": { "items": { "type": "string" }, "title": "Category Ids", "type": "array" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "is_available": { "title": "Is Available", "type": "boolean" }, "market_ids": { "items": { "type": "string" }, "title": "Market Ids", "type": "array" }, "market_scope": { "enum": [ "all", "selected" ], "title": "Market Scope", "type": "string" }, "name": { "title": "Name", "type": "string" }, "phrase_groups": { "items": { "$ref": "#/components/schemas/RulePhraseGroupData" }, "title": "Phrase Groups", "type": "array" }, "product_ids": { "items": { "type": "string" }, "title": "Product Ids", "type": "array" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "name", "enabled", "version", "created_at", "updated_at", "market_scope", "is_available", "phrase_groups", "market_ids", "product_ids", "category_ids" ], "title": "RuleDetailData", "type": "object" }, "RulePhraseGroupData": { "additionalProperties": false, "properties": { "locale": { "title": "Locale", "type": "string" }, "phrases": { "items": { "type": "string" }, "title": "Phrases", "type": "array" } }, "required": [ "locale", "phrases" ], "title": "RulePhraseGroupData", "type": "object" }, "RuleSummaryData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "is_available": { "title": "Is Available", "type": "boolean" }, "market_scope": { "enum": [ "all", "selected" ], "title": "Market Scope", "type": "string" }, "name": { "title": "Name", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "name", "enabled", "version", "created_at", "updated_at", "market_scope", "is_available" ], "title": "RuleSummaryData", "type": "object" }, "RuleUpdate": { "additionalProperties": false, "properties": { "category_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 100, "title": "Category Ids", "type": "array" }, "enabled": { "title": "Enabled", "type": "boolean" }, "expected_version": { "maximum": 2147483647, "minimum": 1, "title": "Expected Version", "type": "integer" }, "market_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 1000, "title": "Market Ids", "type": "array" }, "market_scope": { "enum": [ "all", "selected" ], "title": "Market Scope", "type": "string" }, "name": { "maxLength": 160, "minLength": 1, "title": "Name", "type": "string" }, "phrases": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Phrases", "type": "array" }, "product_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 100, "title": "Product Ids", "type": "array" } }, "required": [ "expected_version" ], "title": "RuleUpdate", "type": "object" }, "SalesLimitUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "reason": { "default": "", "maxLength": 500, "title": "Reason", "type": "string" }, "sellable_limit": { "maximum": 2147483647, "minimum": -1, "title": "Sellable Limit", "type": "integer" } }, "required": [ "expected_version", "sellable_limit" ], "title": "SalesLimitUpdate", "type": "object" }, "ShippingData": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/MoneyData" }, "dates": { "$ref": "#/components/schemas/DeliveryDatesData" }, "method_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method Code" }, "method_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method Name" }, "pickup_point": { "anyOf": [ { "$ref": "#/components/schemas/PickupPointSummaryData" }, { "type": "null" } ] }, "recipient_mode": { "enum": [ "full_address", "pickup_contact" ], "title": "Recipient Mode", "type": "string" } }, "required": [ "recipient_mode", "method_code", "method_name", "amount", "pickup_point", "dates" ], "title": "ShippingData", "type": "object" }, "ShippingDetailData": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/MoneyData" }, "dates": { "$ref": "#/components/schemas/DeliveryDatesData" }, "discount_gross": { "$ref": "#/components/schemas/MoneyData" }, "discount_net": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "discount_tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrderDeliveryDiscountData" }, "type": "array" }, { "type": "null" } ], "title": "Discounts" }, "gross": { "$ref": "#/components/schemas/MoneyData" }, "method_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method Code" }, "method_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method Name" }, "net": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "original_gross": { "$ref": "#/components/schemas/MoneyData" }, "original_net": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "original_tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "pickup_point": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryPickupPointData" }, { "type": "null" } ] }, "recipient_mode": { "enum": [ "full_address", "pickup_contact" ], "title": "Recipient Mode", "type": "string" }, "tax": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "tax_category_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Category Id" }, "tax_category_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Category Name" }, "tax_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Rate" } }, "required": [ "recipient_mode", "method_code", "method_name", "amount", "pickup_point", "dates", "net", "tax", "gross", "original_net", "original_tax", "original_gross", "discount_net", "discount_tax", "discount_gross", "tax_rate", "tax_category_id", "tax_category_name", "discounts" ], "title": "ShippingDetailData", "type": "object" }, "StockAdjustmentCreate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 0, "title": "Expected Version", "type": "integer" }, "locations": { "items": { "$ref": "#/components/schemas/LocationQuantity" }, "maxItems": 100, "minItems": 1, "title": "Locations", "type": "array" }, "reason": { "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string" }, "target_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Target Id", "type": "string" }, "target_type": { "enum": [ "product", "variant" ], "title": "Target Type", "type": "string" }, "warehouse_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Warehouse Id", "type": "string" } }, "required": [ "locations", "reason", "warehouse_id", "target_type", "target_id", "expected_version" ], "title": "StockAdjustmentCreate", "type": "object" }, "StockAdjustmentUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "locations": { "items": { "$ref": "#/components/schemas/LocationQuantity" }, "maxItems": 100, "minItems": 1, "title": "Locations", "type": "array" }, "reason": { "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string" } }, "required": [ "locations", "reason", "expected_version" ], "title": "StockAdjustmentUpdate", "type": "object" }, "StockData": { "additionalProperties": false, "properties": { "active": { "title": "Active", "type": "boolean" }, "available": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Available" }, "id": { "title": "Id", "type": "string" }, "manual_reserved": { "title": "Manual Reserved", "type": "integer" }, "on_hand": { "title": "On Hand", "type": "integer" }, "reserved": { "title": "Reserved", "type": "integer" }, "sellable_limit": { "title": "Sellable Limit", "type": "integer" }, "target_id": { "title": "Target Id", "type": "string" }, "target_type": { "enum": [ "product", "variant" ], "title": "Target Type", "type": "string" }, "total_reserved": { "title": "Total Reserved", "type": "integer" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" }, "warehouse_id": { "title": "Warehouse Id", "type": "string" } }, "required": [ "id", "warehouse_id", "target_type", "target_id", "active", "on_hand", "sellable_limit", "reserved", "manual_reserved", "total_reserved", "available", "version", "updated_at" ], "title": "StockData", "type": "object" }, "StockDetailData": { "additionalProperties": false, "properties": { "active": { "title": "Active", "type": "boolean" }, "allocations": { "items": { "$ref": "#/components/schemas/AllocationData" }, "title": "Allocations", "type": "array" }, "available": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Available" }, "id": { "title": "Id", "type": "string" }, "manual_reserved": { "title": "Manual Reserved", "type": "integer" }, "on_hand": { "title": "On Hand", "type": "integer" }, "reserved": { "title": "Reserved", "type": "integer" }, "sellable_limit": { "title": "Sellable Limit", "type": "integer" }, "target_id": { "title": "Target Id", "type": "string" }, "target_type": { "enum": [ "product", "variant" ], "title": "Target Type", "type": "string" }, "total_reserved": { "title": "Total Reserved", "type": "integer" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" }, "warehouse_id": { "title": "Warehouse Id", "type": "string" } }, "required": [ "id", "warehouse_id", "target_type", "target_id", "active", "on_hand", "sellable_limit", "reserved", "manual_reserved", "total_reserved", "available", "version", "updated_at", "allocations" ], "title": "StockDetailData", "type": "object" }, "TokenData": { "additionalProperties": false, "properties": { "access_token": { "title": "Access Token", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "expires_in": { "default": 900, "title": "Expires In", "type": "integer" }, "rate_limits": { "$ref": "#/components/schemas/TokenRateLimitsData" }, "token_type": { "const": "Bearer", "default": "Bearer", "title": "Token Type", "type": "string" } }, "required": [ "access_token", "expires_at", "rate_limits" ], "title": "TokenData", "type": "object" }, "TokenRateLimitsData": { "additionalProperties": false, "properties": { "auth_per_minute": { "maximum": 1000000, "minimum": 0, "title": "Auth Per Minute", "type": "integer" }, "read_per_minute": { "maximum": 1000000, "minimum": 0, "title": "Read Per Minute", "type": "integer" }, "write_per_minute": { "maximum": 1000000, "minimum": 0, "title": "Write Per Minute", "type": "integer" } }, "required": [ "read_per_minute", "write_per_minute", "auth_per_minute" ], "title": "TokenRateLimitsData", "type": "object" }, "TokenRequest": { "additionalProperties": false, "description": "The credential belongs exclusively to the Authorization header.", "properties": {}, "title": "TokenRequest", "type": "object" }, "VariantChoiceData": { "additionalProperties": false, "properties": { "option_id": { "title": "Option Id", "type": "string" }, "option_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Option Name" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "value_id": { "title": "Value Id", "type": "string" } }, "required": [ "option_id", "value_id", "option_name", "value" ], "title": "VariantChoiceData", "type": "object" }, "VariantCreate": { "additionalProperties": false, "properties": { "active": { "default": true, "title": "Active", "type": "boolean" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "is_default": { "title": "Is Default", "type": "boolean" }, "media_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Media Ids", "type": "array" }, "pricing": { "$ref": "#/components/schemas/VariantPrice", "title": "Pricing" }, "sku": { "maxLength": 100, "minLength": 1, "pattern": "^\\S+$", "title": "Sku", "type": "string" }, "value_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 250, "minItems": 1, "title": "Value Ids", "type": "array" } }, "required": [ "expected_version", "value_ids" ], "title": "VariantCreate", "type": "object" }, "VariantOptionCreate": { "additionalProperties": false, "properties": { "name": { "maxLength": 120, "minLength": 1, "pattern": "^[^\\x00]*$", "title": "Name", "type": "string" }, "selection_type": { "default": "button", "enum": [ "button", "dropdown" ], "title": "Selection Type", "type": "string" }, "value_presentation_type": { "default": "text", "enum": [ "text", "color", "image" ], "title": "Value Presentation Type", "type": "string" } }, "required": [ "name" ], "title": "VariantOptionCreate", "type": "object" }, "VariantOptionUpdate": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "pattern": "^[^\\x00]*$", "type": "string" }, { "type": "null" } ], "title": "Name" }, "selection_type": { "enum": [ "button", "dropdown" ], "title": "Selection Type", "type": "string" }, "value_presentation_type": { "enum": [ "text", "color", "image" ], "title": "Value Presentation Type", "type": "string" } }, "required": [ "expected_version" ], "title": "VariantOptionUpdate", "type": "object" }, "VariantPrice": { "additionalProperties": false, "properties": { "amount": { "anyOf": [ { "maxLength": 20, "pattern": "^-?(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "type": "string" }, { "type": "null" } ], "title": "Amount" }, "currency": { "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string" }, "expected_price_list_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Price List Version", "type": "integer" }, "expected_product_version": { "maximum": 9223372036854775807, "minimum": 0, "title": "Expected Product Version", "type": "integer" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 0, "title": "Expected Version", "type": "integer" }, "kind": { "enum": [ "base_adjustment", "market_fixed" ], "title": "Kind", "type": "string" }, "price_list_id": { "maxLength": 63, "minLength": 1, "title": "Price List Id", "type": "string" } }, "required": [ "kind", "amount", "currency", "price_list_id", "expected_price_list_version", "expected_version", "expected_product_version" ], "title": "VariantPrice", "type": "object" }, "VariantPricingData": { "additionalProperties": false, "properties": { "base_adjustment": { "$ref": "#/components/schemas/MoneyData" }, "market_price": { "anyOf": [ { "$ref": "#/components/schemas/MoneyData" }, { "type": "null" } ] }, "price": { "anyOf": [ { "$ref": "#/components/schemas/PriceData" }, { "type": "null" } ] }, "product_version": { "title": "Product Version", "type": "integer" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "product_version", "base_adjustment", "market_price", "price" ], "title": "VariantPricingData", "type": "object" }, "VariantUpdate": { "additionalProperties": false, "properties": { "active": { "title": "Active", "type": "boolean" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "is_default": { "title": "Is Default", "type": "boolean" }, "media_ids": { "items": { "maxLength": 63, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Media Ids", "type": "array" }, "pricing": { "$ref": "#/components/schemas/VariantPrice", "title": "Pricing" }, "sku": { "maxLength": 100, "minLength": 1, "pattern": "^\\S+$", "title": "Sku", "type": "string" } }, "required": [ "expected_version" ], "title": "VariantUpdate", "type": "object" }, "VariantValueCreate": { "additionalProperties": false, "properties": { "color_hex": { "anyOf": [ { "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string" }, { "type": "null" } ], "title": "Color Hex" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "value": { "maxLength": 180, "minLength": 1, "pattern": "^[^\\x00]*$", "title": "Value", "type": "string" } }, "required": [ "value", "expected_version" ], "title": "VariantValueCreate", "type": "object" }, "VariantValueData": { "additionalProperties": false, "properties": { "color_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Hex" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "image_media_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Media Id" }, "number": { "title": "Number", "type": "string" }, "option_id": { "title": "Option Id", "type": "string" }, "position": { "title": "Position", "type": "integer" }, "sku_code": { "title": "Sku Code", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "created_at", "updated_at", "option_id", "value", "position", "sku_code", "color_hex", "image_media_id", "version" ], "title": "VariantValueData", "type": "object" }, "VariantValueUpdate": { "additionalProperties": false, "properties": { "color_hex": { "anyOf": [ { "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string" }, { "type": "null" } ], "title": "Color Hex" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "value": { "anyOf": [ { "maxLength": 180, "minLength": 1, "pattern": "^[^\\x00]*$", "type": "string" }, { "type": "null" } ], "title": "Value" } }, "required": [ "expected_version" ], "title": "VariantValueUpdate", "type": "object" }, "WarehouseData": { "additionalProperties": false, "properties": { "active": { "title": "Active", "type": "boolean" }, "address_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Line" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "code": { "title": "Code", "type": "string" }, "country_code": { "title": "Country Code", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "customer_visible": { "title": "Customer Visible", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "code", "name", "address_line", "postal_code", "city", "country_code", "customer_visible", "active", "version", "created_at", "updated_at" ], "title": "WarehouseData", "type": "object" }, "ZeroResultScope": { "enum": [ "all", "has_zero_results", "no_zero_results" ], "title": "ZeroResultScope", "type": "string" }, "shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "number": { "title": "Number", "type": "string" }, "position": { "title": "Position", "type": "integer" }, "selection_type": { "enum": [ "button", "dropdown" ], "title": "Selection Type", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "value_presentation_type": { "enum": [ "text", "color", "image" ], "title": "Value Presentation Type", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "number", "created_at", "updated_at", "name", "position", "selection_type", "value_presentation_type", "version" ], "title": "VariantOptionData", "type": "object" }, "shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData": { "additionalProperties": false, "properties": { "currency": { "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string" }, "fixed_amount": { "default": "0", "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "title": "Fixed Amount", "type": "string" }, "market_id": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Market Id", "type": "string" }, "maximum_price": { "anyOf": [ { "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "type": "string" }, { "type": "null" } ], "title": "Maximum Price" }, "minimum_price": { "anyOf": [ { "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "type": "string" }, { "type": "null" } ], "title": "Minimum Price" }, "minimum_subtotal": { "default": "0", "maxLength": 19, "pattern": "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$", "title": "Minimum Subtotal", "type": "string" }, "minor_units": { "maximum": 4, "minimum": 0, "title": "Minor Units", "type": "integer" } }, "required": [ "market_id", "currency", "minor_units" ], "title": "MarketData", "type": "object" }, "shopently_engine__domains__global_commerce__adapters__public_http__context__schemas__MarketData": { "additionalProperties": false, "properties": { "code": { "title": "Code", "type": "string" }, "currency": { "anyOf": [ { "$ref": "#/components/schemas/CurrencyData" }, { "type": "null" } ] }, "id": { "title": "Id", "type": "string" }, "is_default": { "title": "Is Default", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "price_list": { "anyOf": [ { "$ref": "#/components/schemas/PriceListData" }, { "type": "null" } ] }, "status": { "enum": [ "draft", "sales_active", "suspended" ], "title": "Status", "type": "string" } }, "required": [ "id", "code", "name", "status", "is_default", "currency", "price_list" ], "title": "MarketData", "type": "object" }, "shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_initial": { "title": "Is Initial", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "position": { "title": "Position", "type": "integer" } }, "required": [ "id", "name", "position", "is_initial", "created_at" ], "title": "StatusDefinitionData", "type": "object" }, "shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "name", "value" ], "title": "VariantOptionData", "type": "object" }, "shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData": { "additionalProperties": false, "properties": { "code": { "title": "Code", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_initial": { "title": "Is Initial", "type": "boolean" }, "locale": { "title": "Locale", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "position": { "title": "Position", "type": "integer" }, "type": { "$ref": "#/components/schemas/RequestType" } }, "required": [ "id", "type", "code", "name", "locale", "position", "is_initial", "created_at" ], "title": "StatusDefinitionData", "type": "object" }, "shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "name", "value" ], "title": "VariantOptionData", "type": "object" }, "shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[StatusDefinitionData]]", "type": "object" }, "shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData" }, "title": "Data", "type": "array" }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ContextPageMeta" }, { "$ref": "#/components/schemas/ContextMeta" }, { "$ref": "#/components/schemas/PageMeta" }, { "$ref": "#/components/schemas/RequestMeta" } ], "title": "Meta" } }, "required": [ "data", "meta" ], "title": "ApiResponse[list[StatusDefinitionData]]", "type": "object" } }, "securitySchemes": { "ApiKey": { "scheme": "ApiKey", "type": "http" }, "Bearer": { "scheme": "Bearer", "type": "http" } } }, "info": { "title": "Shopently API", "version": "4.181.0" }, "openapi": "3.1.0", "paths": { "/api/v1/addons/shopently.blog/authors": { "get": { "operationId": "addon_shopently_blog_author_list", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "biography_preview": { "maxLength": 250, "title": "Biography Preview", "type": "string" }, "display_name": { "maxLength": 160, "minLength": 1, "title": "Display Name", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "display_name", "biography_preview", "is_active" ], "title": "AuthorListItem", "type": "object" }, "maxItems": 100, "title": "Items", "type": "array" }, "meta": { "additionalProperties": false, "properties": { "pagination": { "additionalProperties": false, "properties": { "has_more": { "type": "boolean" }, "limit": { "maximum": 100, "minimum": 1, "type": "integer" }, "next_cursor": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ] } }, "required": [ "limit", "next_cursor", "has_more" ], "type": "object" }, "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id", "pagination" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:author_read" ] } }, "post": { "operationId": "addon_shopently_blog_author_create", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "biography": { "maxLength": 5000, "title": "Biography", "type": "string" }, "display_name": { "maxLength": 160, "minLength": 1, "title": "Display Name", "type": "string" }, "expected_version": { "const": 1, "default": 1, "title": "Expected Version", "type": "integer" }, "is_active": { "title": "Is Active", "type": "boolean" } }, "required": [ "display_name", "biography", "is_active" ], "title": "CreateAuthor", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version" ], "title": "Saved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:author_create" ] } } }, "/api/v1/addons/shopently.blog/authors/{author_id}": { "delete": { "operationId": "addon_shopently_blog_author_delete", "parameters": [ { "in": "path", "name": "author_id", "required": true, "schema": { "format": "uuid", "title": "Author Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "deleted": { "const": true, "title": "Deleted", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" } }, "required": [ "id", "deleted" ], "title": "Deleted", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:author_delete" ] } }, "get": { "operationId": "addon_shopently_blog_author_read", "parameters": [ { "in": "path", "name": "author_id", "required": true, "schema": { "format": "uuid", "title": "Author Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "biography": { "maxLength": 5000, "title": "Biography", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "display_name": { "maxLength": 160, "minLength": 1, "title": "Display Name", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "display_name", "biography", "is_active", "id", "version", "created_at", "updated_at" ], "title": "AuthorDocument", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:author_read" ] } }, "patch": { "operationId": "addon_shopently_blog_author_update", "parameters": [ { "in": "path", "name": "author_id", "required": true, "schema": { "format": "uuid", "title": "Author Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "biography": { "maxLength": 5000, "title": "Biography", "type": "string" }, "display_name": { "maxLength": 160, "minLength": 1, "title": "Display Name", "type": "string" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "is_active": { "title": "Is Active", "type": "boolean" } }, "required": [ "expected_version" ], "title": "PatchAuthor", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version" ], "title": "Saved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:author_update" ] } } }, "/api/v1/addons/shopently.blog/comments": { "get": { "operationId": "addon_shopently_blog_comment_list", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "post_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Post Id" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "enum": [ "pending", "approved", "rejected", "spam" ], "type": "string" }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "actor_kind": { "enum": [ "administrator", "customer", "api" ], "title": "Actor Kind", "type": "string" }, "body_preview": { "maxLength": 250, "minLength": 1, "title": "Body Preview", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "display_name": { "maxLength": 160, "minLength": 1, "title": "Display Name", "type": "string" }, "edited_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Edited At" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "locale": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" }, "post_id": { "format": "uuid", "title": "Post Id", "type": "string" }, "status": { "enum": [ "pending", "approved", "rejected", "spam" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "post_id", "version", "display_name", "body_preview", "locale", "actor_kind", "status", "created_at", "edited_at" ], "title": "CommentListItem", "type": "object" }, "maxItems": 100, "title": "Items", "type": "array" }, "meta": { "additionalProperties": false, "properties": { "pagination": { "additionalProperties": false, "properties": { "has_more": { "type": "boolean" }, "limit": { "maximum": 100, "minimum": 1, "type": "integer" }, "next_cursor": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ] } }, "required": [ "limit", "next_cursor", "has_more" ], "type": "object" }, "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id", "pagination" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:comment_read" ] } }, "post": { "operationId": "addon_shopently_blog_comment_create", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "body": { "maxLength": 5000, "minLength": 1, "title": "Body", "type": "string" }, "display_name": { "maxLength": 160, "minLength": 1, "title": "Display Name", "type": "string" }, "expected_version": { "const": 1, "default": 1, "title": "Expected Version", "type": "integer" }, "locale": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" }, "post_id": { "format": "uuid", "title": "Post Id", "type": "string" } }, "required": [ "display_name", "body", "locale", "post_id" ], "title": "CreateComment", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "status": { "enum": [ "pending", "approved", "rejected", "spam" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status" ], "title": "CommentSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:comment_create" ] } } }, "/api/v1/addons/shopently.blog/comments/{comment_id}": { "delete": { "operationId": "addon_shopently_blog_comment_delete", "parameters": [ { "in": "path", "name": "comment_id", "required": true, "schema": { "format": "uuid", "title": "Comment Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "deleted": { "const": true, "title": "Deleted", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" } }, "required": [ "id", "deleted" ], "title": "Deleted", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:comment_delete" ] } }, "get": { "operationId": "addon_shopently_blog_comment_read", "parameters": [ { "in": "path", "name": "comment_id", "required": true, "schema": { "format": "uuid", "title": "Comment Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "actor_id": { "maxLength": 63, "minLength": 1, "title": "Actor Id", "type": "string" }, "actor_kind": { "enum": [ "administrator", "customer", "api" ], "title": "Actor Kind", "type": "string" }, "body": { "maxLength": 5000, "minLength": 1, "title": "Body", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "display_name": { "maxLength": 160, "minLength": 1, "title": "Display Name", "type": "string" }, "edited_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Edited At" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "locale": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" }, "moderation_reason": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Moderation Reason" }, "post_id": { "format": "uuid", "title": "Post Id", "type": "string" }, "status": { "enum": [ "pending", "approved", "rejected", "spam" ], "title": "Status", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "display_name", "body", "locale", "id", "post_id", "actor_kind", "actor_id", "status", "version", "edited_at", "moderation_reason", "created_at", "updated_at" ], "title": "CommentDocument", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:comment_read" ] } }, "patch": { "operationId": "addon_shopently_blog_comment_update", "parameters": [ { "in": "path", "name": "comment_id", "required": true, "schema": { "format": "uuid", "title": "Comment Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "body": { "maxLength": 5000, "minLength": 1, "title": "Body", "type": "string" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, "required": [ "expected_version", "body" ], "title": "UpdateComment", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "status": { "enum": [ "pending", "approved", "rejected", "spam" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status" ], "title": "CommentSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:comment_update" ] } } }, "/api/v1/addons/shopently.blog/comments/{comment_id}/moderate": { "post": { "operationId": "addon_shopently_blog_comment_moderate", "parameters": [ { "in": "path", "name": "comment_id", "required": true, "schema": { "format": "uuid", "title": "Comment Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "reason": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Reason" }, "status": { "enum": [ "pending", "approved", "rejected", "spam" ], "title": "Status", "type": "string" } }, "required": [ "expected_version", "status" ], "title": "ModerateComment", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "status": { "enum": [ "pending", "approved", "rejected", "spam" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status" ], "title": "CommentSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:comment_moderate" ] } } }, "/api/v1/addons/shopently.blog/media": { "get": { "operationId": "addon_shopently_blog_media_list", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "bytes": { "maximum": 15728640, "minimum": 1, "title": "Bytes", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "height": { "maximum": 1600, "minimum": 1, "title": "Height", "type": "integer" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "mime_type": { "const": "image/webp", "title": "Mime Type", "type": "string" }, "state": { "enum": [ "staged", "ready" ], "title": "State", "type": "string" }, "variants": { "additionalProperties": false, "properties": { "card": { "additionalProperties": false, "properties": { "bytes": { "maximum": 5242880, "minimum": 1, "title": "Bytes", "type": "integer" }, "height": { "maximum": 1600, "minimum": 1, "title": "Height", "type": "integer" }, "width": { "maximum": 1600, "minimum": 1, "title": "Width", "type": "integer" } }, "required": [ "width", "height", "bytes" ], "title": "ImageVariant", "type": "object" }, "original": { "additionalProperties": false, "properties": { "bytes": { "maximum": 5242880, "minimum": 1, "title": "Bytes", "type": "integer" }, "height": { "maximum": 1600, "minimum": 1, "title": "Height", "type": "integer" }, "width": { "maximum": 1600, "minimum": 1, "title": "Width", "type": "integer" } }, "required": [ "width", "height", "bytes" ], "title": "ImageVariant", "type": "object" }, "thumbnail": { "additionalProperties": false, "properties": { "bytes": { "maximum": 5242880, "minimum": 1, "title": "Bytes", "type": "integer" }, "height": { "maximum": 1600, "minimum": 1, "title": "Height", "type": "integer" }, "width": { "maximum": 1600, "minimum": 1, "title": "Width", "type": "integer" } }, "required": [ "width", "height", "bytes" ], "title": "ImageVariant", "type": "object" } }, "required": [ "original", "card", "thumbnail" ], "title": "ImageVariants", "type": "object" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" }, "width": { "maximum": 1600, "minimum": 1, "title": "Width", "type": "integer" } }, "required": [ "id", "version", "mime_type", "bytes", "width", "height", "variants", "state", "created_at", "expires_at" ], "title": "MediaDocument", "type": "object" }, "maxItems": 100, "title": "Items", "type": "array" }, "meta": { "additionalProperties": false, "properties": { "pagination": { "additionalProperties": false, "properties": { "has_more": { "type": "boolean" }, "limit": { "maximum": 100, "minimum": 1, "type": "integer" }, "next_cursor": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ] } }, "required": [ "limit", "next_cursor", "has_more" ], "type": "object" }, "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id", "pagination" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:media_read" ] } }, "post": { "operationId": "addon_shopently_blog_media_upload", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "bytes": { "maximum": 15728640, "minimum": 1, "title": "Bytes", "type": "integer" }, "height": { "maximum": 1600, "minimum": 1, "title": "Height", "type": "integer" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" }, "width": { "maximum": 1600, "minimum": 1, "title": "Width", "type": "integer" } }, "required": [ "id", "version", "width", "height", "bytes" ], "title": "MediaUploaded", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:media_upload" ] }, "x-shopently-image-upload": 5242880 } }, "/api/v1/addons/shopently.blog/media/{media_id}": { "delete": { "operationId": "addon_shopently_blog_media_delete", "parameters": [ { "in": "path", "name": "media_id", "required": true, "schema": { "format": "uuid", "title": "Media Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "deleted": { "const": true, "title": "Deleted", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "deleted" ], "title": "MediaDeleted", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:media_delete" ] } }, "get": { "operationId": "addon_shopently_blog_media_read", "parameters": [ { "in": "path", "name": "media_id", "required": true, "schema": { "format": "uuid", "title": "Media Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "bytes": { "maximum": 15728640, "minimum": 1, "title": "Bytes", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "height": { "maximum": 1600, "minimum": 1, "title": "Height", "type": "integer" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "mime_type": { "const": "image/webp", "title": "Mime Type", "type": "string" }, "state": { "enum": [ "staged", "ready" ], "title": "State", "type": "string" }, "variants": { "additionalProperties": false, "properties": { "card": { "additionalProperties": false, "properties": { "bytes": { "maximum": 5242880, "minimum": 1, "title": "Bytes", "type": "integer" }, "height": { "maximum": 1600, "minimum": 1, "title": "Height", "type": "integer" }, "width": { "maximum": 1600, "minimum": 1, "title": "Width", "type": "integer" } }, "required": [ "width", "height", "bytes" ], "title": "ImageVariant", "type": "object" }, "original": { "additionalProperties": false, "properties": { "bytes": { "maximum": 5242880, "minimum": 1, "title": "Bytes", "type": "integer" }, "height": { "maximum": 1600, "minimum": 1, "title": "Height", "type": "integer" }, "width": { "maximum": 1600, "minimum": 1, "title": "Width", "type": "integer" } }, "required": [ "width", "height", "bytes" ], "title": "ImageVariant", "type": "object" }, "thumbnail": { "additionalProperties": false, "properties": { "bytes": { "maximum": 5242880, "minimum": 1, "title": "Bytes", "type": "integer" }, "height": { "maximum": 1600, "minimum": 1, "title": "Height", "type": "integer" }, "width": { "maximum": 1600, "minimum": 1, "title": "Width", "type": "integer" } }, "required": [ "width", "height", "bytes" ], "title": "ImageVariant", "type": "object" } }, "required": [ "original", "card", "thumbnail" ], "title": "ImageVariants", "type": "object" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" }, "width": { "maximum": 1600, "minimum": 1, "title": "Width", "type": "integer" } }, "required": [ "id", "version", "mime_type", "bytes", "width", "height", "variants", "state", "created_at", "expires_at" ], "title": "MediaDocument", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:media_read" ] } } }, "/api/v1/addons/shopently.blog/media/{media_id}/file": { "get": { "operationId": "addon_shopently_blog_media_file", "parameters": [ { "in": "path", "name": "media_id", "required": true, "schema": { "format": "uuid", "title": "Media Id", "type": "string" } }, { "in": "query", "name": "variant", "required": false, "schema": { "default": "original", "enum": [ "original", "card", "thumbnail" ], "title": "Variant", "type": "string" } } ], "responses": { "200": { "content": { "image/webp": { "schema": { "format": "binary", "type": "string" } } }, "description": "Private image variant" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:media_read" ] } } }, "/api/v1/addons/shopently.blog/posts": { "get": { "operationId": "addon_shopently_blog_post_list", "parameters": [ { "in": "query", "name": "locale", "required": true, "schema": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "enum": [ "draft", "scheduled", "published", "archived" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "title", "required": false, "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Title" } }, { "in": "query", "name": "author_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Author Id" } }, { "in": "query", "name": "publish_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Publish From" } }, { "in": "query", "name": "publish_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Publish To" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "author_name": { "maxLength": 160, "title": "Author Name", "type": "string" }, "cover_alt": { "maxLength": 250, "title": "Cover Alt", "type": "string" }, "cover_media_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Cover Media Id" }, "first_published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "First Published At" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "public_number": { "minimum": 1, "title": "Public Number", "type": "integer" }, "publish_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Publish At" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "title": { "maxLength": 200, "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "cover_media_id", "cover_alt", "id", "public_number", "title", "author_name", "status", "version", "publish_at", "first_published_at", "updated_at" ], "title": "PostListItem", "type": "object" }, "maxItems": 100, "title": "Items", "type": "array" }, "meta": { "additionalProperties": false, "properties": { "pagination": { "additionalProperties": false, "properties": { "has_more": { "type": "boolean" }, "limit": { "maximum": 100, "minimum": 1, "type": "integer" }, "next_cursor": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ] } }, "required": [ "limit", "next_cursor", "has_more" ], "type": "object" }, "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id", "pagination" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_read" ] } }, "post": { "operationId": "addon_shopently_blog_post_create", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "author_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Author Id" }, "comments_mode": { "enum": [ "inherit", "open", "closed" ], "title": "Comments Mode", "type": "string" }, "content_html": { "maxLength": 50000, "title": "Content Html", "type": "string", "x-shopently-control": "rich_text", "x-shopently-html-profile": "category-v1" }, "cover_alt": { "maxLength": 250, "title": "Cover Alt", "type": "string" }, "cover_caption": { "maxLength": 500, "title": "Cover Caption", "type": "string" }, "cover_media_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Cover Media Id", "x-shopently-control": "media" }, "excerpt": { "maxLength": 1000, "title": "Excerpt", "type": "string" }, "expected_version": { "const": 1, "default": 1, "title": "Expected Version", "type": "integer" }, "locale": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" }, "meta_description": { "maxLength": 160, "title": "Meta Description", "type": "string", "x-shopently-character-counter": true, "x-shopently-control": "textarea" }, "meta_keywords": { "items": { "maxLength": 50, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Meta Keywords", "type": "array", "x-shopently-control": "keywords" }, "meta_title": { "maxLength": 70, "title": "Meta Title", "type": "string", "x-shopently-character-counter": true }, "slug": { "maxLength": 160, "title": "Slug", "type": "string" }, "title": { "maxLength": 200, "title": "Title", "type": "string" } }, "required": [ "locale", "title", "slug", "excerpt", "content_html", "meta_title", "meta_description", "meta_keywords", "cover_media_id", "cover_alt", "cover_caption", "author_id", "comments_mode" ], "title": "CreatePost", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "html_normalized": { "title": "Html Normalized", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "public_number": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Public Number" }, "revision_id": { "format": "uuid", "title": "Revision Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status", "revision_id", "html_normalized" ], "title": "DraftSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_create" ] } } }, "/api/v1/addons/shopently.blog/posts/{post_id}": { "delete": { "operationId": "addon_shopently_blog_post_delete", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "deleted": { "const": true, "title": "Deleted", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" } }, "required": [ "id", "deleted" ], "title": "Deleted", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_delete" ] } }, "get": { "operationId": "addon_shopently_blog_post_read", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "in": "query", "name": "locale", "required": true, "schema": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "author_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Author Id" }, "comments_mode": { "enum": [ "inherit", "open", "closed" ], "title": "Comments Mode", "type": "string" }, "content_html": { "maxLength": 50000, "title": "Content Html", "type": "string", "x-shopently-control": "rich_text", "x-shopently-html-profile": "category-v1" }, "cover_alt": { "maxLength": 250, "title": "Cover Alt", "type": "string" }, "cover_caption": { "maxLength": 500, "title": "Cover Caption", "type": "string" }, "cover_media_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Cover Media Id", "x-shopently-control": "media" }, "draft_revision_id": { "format": "uuid", "title": "Draft Revision Id", "type": "string" }, "excerpt": { "maxLength": 1000, "title": "Excerpt", "type": "string" }, "first_published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "First Published At" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "last_published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Published At" }, "locale": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" }, "meta_description": { "maxLength": 160, "title": "Meta Description", "type": "string", "x-shopently-character-counter": true, "x-shopently-control": "textarea" }, "meta_keywords": { "items": { "maxLength": 50, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Meta Keywords", "type": "array", "x-shopently-control": "keywords" }, "meta_title": { "maxLength": 70, "title": "Meta Title", "type": "string", "x-shopently-character-counter": true }, "public_number": { "minimum": 1, "title": "Public Number", "type": "integer" }, "publish_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Publish At" }, "publish_timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Publish Timezone" }, "published_revision_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Published Revision Id" }, "schedule_state": { "anyOf": [ { "enum": [ "armed", "requires_confirmation" ], "type": "string" }, { "type": "null" } ], "title": "Schedule State" }, "scheduled_revision_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Scheduled Revision Id" }, "slug": { "maxLength": 160, "title": "Slug", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "title": { "maxLength": 200, "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "locale", "title", "slug", "excerpt", "content_html", "meta_title", "meta_description", "meta_keywords", "cover_media_id", "cover_alt", "cover_caption", "author_id", "comments_mode", "id", "public_number", "version", "status", "draft_revision_id", "published_revision_id", "scheduled_revision_id", "publish_at", "publish_timezone", "schedule_state", "first_published_at", "last_published_at", "updated_at" ], "title": "PostDocument", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_read" ] } }, "patch": { "operationId": "addon_shopently_blog_post_update", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "author_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Author Id" }, "comments_mode": { "enum": [ "inherit", "open", "closed" ], "title": "Comments Mode", "type": "string" }, "content_html": { "maxLength": 50000, "title": "Content Html", "type": "string", "x-shopently-control": "rich_text", "x-shopently-html-profile": "category-v1" }, "cover_alt": { "maxLength": 250, "title": "Cover Alt", "type": "string" }, "cover_caption": { "maxLength": 500, "title": "Cover Caption", "type": "string" }, "cover_media_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Cover Media Id", "x-shopently-control": "media" }, "excerpt": { "maxLength": 1000, "title": "Excerpt", "type": "string" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "locale": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" }, "meta_description": { "maxLength": 160, "title": "Meta Description", "type": "string", "x-shopently-character-counter": true, "x-shopently-control": "textarea" }, "meta_keywords": { "items": { "maxLength": 50, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Meta Keywords", "type": "array", "x-shopently-control": "keywords" }, "meta_title": { "maxLength": 70, "title": "Meta Title", "type": "string", "x-shopently-character-counter": true }, "slug": { "maxLength": 160, "title": "Slug", "type": "string" }, "title": { "maxLength": 200, "title": "Title", "type": "string" } }, "required": [ "expected_version", "locale" ], "title": "PatchPost", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "html_normalized": { "title": "Html Normalized", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "public_number": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Public Number" }, "revision_id": { "format": "uuid", "title": "Revision Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status", "revision_id", "html_normalized" ], "title": "DraftSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_update" ] } } }, "/api/v1/addons/shopently.blog/posts/{post_id}/archive": { "post": { "operationId": "addon_shopently_blog_post_archive", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, "required": [ "expected_version" ], "title": "VersionCommand", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status" ], "title": "PublicationSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_publish" ] } } }, "/api/v1/addons/shopently.blog/posts/{post_id}/publish": { "post": { "operationId": "addon_shopently_blog_post_publish", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "revision_id": { "format": "uuid", "title": "Revision Id", "type": "string" } }, "required": [ "expected_version", "revision_id" ], "title": "PublishCommand", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status" ], "title": "PublicationSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_publish" ] } } }, "/api/v1/addons/shopently.blog/posts/{post_id}/schedule": { "delete": { "operationId": "addon_shopently_blog_post_cancel_schedule", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status" ], "title": "PublicationSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_publish" ] } }, "post": { "operationId": "addon_shopently_blog_post_schedule", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "publish_at": { "format": "date-time", "title": "Publish At", "type": "string", "x-shopently-control": "date_time", "x-shopently-timezone-field": "timezone" }, "revision_id": { "format": "uuid", "title": "Revision Id", "type": "string" }, "timezone": { "maxLength": 64, "minLength": 1, "title": "Timezone", "type": "string" } }, "required": [ "expected_version", "revision_id", "publish_at", "timezone" ], "title": "ScheduleCommand", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "publish_at": { "format": "date-time", "title": "Publish At", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status", "publish_at" ], "title": "ScheduleSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_publish" ] } } }, "/api/v1/auth/token": { "post": { "operationId": "token_api_v1_auth_token_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TokenRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_TokenData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "ApiKey": [] } ], "summary": "Token", "tags": [ "Authentication" ], "x-shopently-access": { "api_plan_features": [ "api.enabled" ], "conditional_scopes": [], "required_scopes": [] } } }, "/api/v1/brands": { "get": { "operationId": "collection_api_v1_brands_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_BrandData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:read" ] } }, "post": { "operationId": "create_brand_api_v1_brands_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Brand", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:create" ] } } }, "/api/v1/brands/{identity}": { "delete": { "operationId": "delete_brand_api_v1_brands__identity__delete", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Brand", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:delete" ] } }, "get": { "operationId": "record_api_v1_brands__identity__get", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_BrandData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:read" ] } }, "patch": { "operationId": "update_brand_api_v1_brands__identity__patch", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Brand", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:update" ] } } }, "/api/v1/categories": { "get": { "operationId": "category_list_api_v1_categories_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "parent_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Parent Id" } }, { "in": "query", "name": "is_visible", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Visible" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_CategorySummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Category List", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:read" ] } }, "post": { "operationId": "create_category_api_v1_categories_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Category", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:create" ] } } }, "/api/v1/categories/{category_id}": { "delete": { "operationId": "delete_category_api_v1_categories__category_id__delete", "parameters": [ { "in": "path", "name": "category_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Category Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Category", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:delete" ] } }, "get": { "operationId": "category_detail_api_v1_categories__category_id__get", "parameters": [ { "in": "path", "name": "category_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Category Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_CategoryDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Category Detail", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:read" ] } }, "patch": { "operationId": "update_category_api_v1_categories__category_id__patch", "parameters": [ { "in": "path", "name": "category_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Category Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Category", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:update" ] } } }, "/api/v1/context": { "get": { "operationId": "context_api_v1_context_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_ContextData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Context", "tags": [ "Context" ], "x-shopently-access": { "api_plan_features": [ "api.enabled" ], "conditional_scopes": [], "required_scopes": [] } } }, "/api/v1/discounts/coupons": { "get": { "operationId": "collection_api_v1_discounts_coupons_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_CampaignData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:read" ] } }, "post": { "operationId": "create_campaign_api_v1_discounts_coupons_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Campaign", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:create" ] } } }, "/api/v1/discounts/coupons/{identity}": { "get": { "operationId": "record_api_v1_discounts_coupons__identity__get", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_CampaignData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:read" ] } }, "patch": { "operationId": "update_campaign_api_v1_discounts_coupons__identity__patch", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Campaign", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:update" ] } } }, "/api/v1/discounts/coupons/{identity}/status": { "patch": { "operationId": "campaign_status_api_v1_discounts_coupons__identity__status_patch", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStatus" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Campaign Status", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:change_status" ] } } }, "/api/v1/discounts/promotions": { "get": { "operationId": "collection_api_v1_discounts_promotions_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_CampaignData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:read" ] } }, "post": { "operationId": "create_campaign_api_v1_discounts_promotions_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Campaign", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:create" ] } } }, "/api/v1/discounts/promotions/{identity}": { "get": { "operationId": "record_api_v1_discounts_promotions__identity__get", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_CampaignData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:read" ] } }, "patch": { "operationId": "update_campaign_api_v1_discounts_promotions__identity__patch", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Campaign", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:update" ] } } }, "/api/v1/discounts/promotions/{identity}/status": { "patch": { "operationId": "campaign_status_api_v1_discounts_promotions__identity__status_patch", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStatus" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Campaign Status", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:change_status" ] } } }, "/api/v1/features": { "get": { "operationId": "collection_api_v1_features_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_FeatureData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:read" ] } }, "post": { "operationId": "create_feature_api_v1_features_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Feature", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:create" ] } } }, "/api/v1/features/{identity}": { "delete": { "operationId": "delete_feature_api_v1_features__identity__delete", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Feature", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:delete" ] } }, "get": { "operationId": "record_api_v1_features__identity__get", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_FeatureData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:read" ] } }, "patch": { "operationId": "update_feature_api_v1_features__identity__patch", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Feature", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:update" ] } } }, "/api/v1/features/{identity}/values": { "get": { "operationId": "values_api_v1_features__identity__values_get", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_FeatureValueData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Values", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:read" ] } }, "post": { "operationId": "create_feature_value_api_v1_features__identity__values_post", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureValueCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Feature Value", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:create" ] } } }, "/api/v1/features/{identity}/values/{value_id}": { "delete": { "operationId": "delete_feature_value_api_v1_features__identity__values__value_id__delete", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Feature Value", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:delete" ] } }, "get": { "operationId": "value_record_api_v1_features__identity__values__value_id__get", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_FeatureValueData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Value Record", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:read" ] } }, "patch": { "operationId": "update_feature_value_api_v1_features__identity__values__value_id__patch", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureValueUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Feature Value", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:update" ] } } }, "/api/v1/inventory/deliveries": { "get": { "operationId": "delivery_list_api_v1_inventory_deliveries_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "warehouse_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Warehouse Id" } }, { "in": "query", "name": "target_type", "required": false, "schema": { "anyOf": [ { "enum": [ "product", "variant" ], "type": "string" }, { "type": "null" } ], "title": "Target Type" } }, { "in": "query", "name": "target_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Target Id" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "enum": [ "planned", "received" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "record_status", "required": false, "schema": { "anyOf": [ { "enum": [ "active", "deleted" ], "type": "string" }, { "type": "null" } ], "title": "Record Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_DeliveryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delivery List", "tags": [ "Deliveries" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock_delivery:read" ] } }, "post": { "operationId": "create_delivery_api_v1_inventory_deliveries_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Delivery", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock_delivery:create" ] } } }, "/api/v1/inventory/deliveries/{delivery_id}": { "get": { "operationId": "delivery_detail_api_v1_inventory_deliveries__delivery_id__get", "parameters": [ { "in": "path", "name": "delivery_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Delivery Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_DeliveryDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delivery Detail", "tags": [ "Deliveries" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock_delivery:read" ] } } }, "/api/v1/inventory/stock": { "get": { "operationId": "stock_list_api_v1_inventory_stock_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "warehouse_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Warehouse Id" } }, { "in": "query", "name": "target_type", "required": false, "schema": { "anyOf": [ { "enum": [ "product", "variant" ], "type": "string" }, { "type": "null" } ], "title": "Target Type" } }, { "in": "query", "name": "target_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Target Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_StockData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Stock List", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } } }, "/api/v1/inventory/stock-adjustments": { "post": { "operationId": "create_adjustment_api_v1_inventory_stock_adjustments_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockAdjustmentCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Adjustment", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:update" ] } } }, "/api/v1/inventory/stock/{stock_id}": { "get": { "operationId": "stock_detail_api_v1_inventory_stock__stock_id__get", "parameters": [ { "in": "path", "name": "stock_id", "required": true, "schema": { "maxLength": 256, "minLength": 1, "title": "Stock Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_StockDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Stock Detail", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } }, "patch": { "operationId": "update_stock_api_v1_inventory_stock__stock_id__patch", "parameters": [ { "in": "path", "name": "stock_id", "required": true, "schema": { "maxLength": 256, "minLength": 1, "title": "Stock Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockAdjustmentUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Stock", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:update" ] } } }, "/api/v1/inventory/stock/{stock_id}/manual-reservation": { "patch": { "operationId": "update_manual_reservation_api_v1_inventory_stock__stock_id__manual_reservation_patch", "parameters": [ { "in": "path", "name": "stock_id", "required": true, "schema": { "maxLength": 256, "minLength": 1, "title": "Stock Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManualReservationUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Manual Reservation", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:update_manual_reservation" ] } } }, "/api/v1/inventory/stock/{stock_id}/sales-limit": { "patch": { "operationId": "update_sales_limit_api_v1_inventory_stock__stock_id__sales_limit_patch", "parameters": [ { "in": "path", "name": "stock_id", "required": true, "schema": { "maxLength": 256, "minLength": 1, "title": "Stock Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesLimitUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Sales Limit", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:update_sales_limit" ] } } }, "/api/v1/inventory/warehouses": { "get": { "operationId": "warehouse_list_api_v1_inventory_warehouses_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "active", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_WarehouseData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Warehouse List", "tags": [ "Warehouses" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } } }, "/api/v1/inventory/warehouses/{warehouse_id}": { "get": { "operationId": "warehouse_detail_api_v1_inventory_warehouses__warehouse_id__get", "parameters": [ { "in": "path", "name": "warehouse_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Warehouse Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_WarehouseData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Warehouse Detail", "tags": [ "Warehouses" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } } }, "/api/v1/inventory/warehouses/{warehouse_id}/locations": { "get": { "operationId": "locations_api_v1_inventory_warehouses__warehouse_id__locations_get", "parameters": [ { "in": "path", "name": "warehouse_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Warehouse Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "parent_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Parent Id" } }, { "in": "query", "name": "is_leaf", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Leaf" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_LocationData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Locations", "tags": [ "Warehouses" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } } }, "/api/v1/order-statuses": { "get": { "operationId": "order_statuses_api_v1_order_statuses_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Order Statuses", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.order:read" ] } } }, "/api/v1/orders": { "get": { "operationId": "order_list_api_v1_orders_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "number", "required": false, "schema": { "anyOf": [ { "maxLength": 48, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Number" } }, { "in": "query", "name": "status_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Status Id" } }, { "in": "query", "name": "payment_status", "required": false, "schema": { "anyOf": [ { "enum": [ "unpaid", "paid", "failed", "refunded" ], "type": "string" }, { "type": "null" } ], "title": "Payment Status" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_OrderSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Order List", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.order:read" ] } } }, "/api/v1/orders/{order_id}": { "get": { "operationId": "order_detail_api_v1_orders__order_id__get", "parameters": [ { "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_OrderDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Order Detail", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.order:read" ] } } }, "/api/v1/orders/{order_id}/payment-status": { "patch": { "operationId": "adjust_payment_status_api_v1_orders__order_id__payment_status_patch", "parameters": [ { "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Adjust Payment Status", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "payments.payment:adjust_status" ] } } }, "/api/v1/orders/{order_id}/status": { "patch": { "operationId": "update_order_status_api_v1_orders__order_id__status_patch", "parameters": [ { "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Order Status", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.order:change_status" ] } } }, "/api/v1/pages": { "get": { "operationId": "pages_api_v1_pages_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "published", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Published" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_PageSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Pages", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:read" ] } }, "post": { "operationId": "create_page_api_v1_pages_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Page", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:create" ] } } }, "/api/v1/pages/{page_id}": { "delete": { "operationId": "delete_page_api_v1_pages__page_id__delete", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Page Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 2147483647, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Page", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:delete" ] } }, "get": { "operationId": "get_page_api_v1_pages__page_id__get", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Page Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_PageDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Get Page", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:read" ] } }, "patch": { "operationId": "update_page_api_v1_pages__page_id__patch", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Page Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Page", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:update" ] } } }, "/api/v1/products": { "get": { "operationId": "product_list_api_v1_products_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "sku", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "minLength": 1, "pattern": "^\\S+$", "type": "string" }, { "type": "null" } ], "title": "Sku" } }, { "in": "query", "name": "published", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Published" } }, { "in": "query", "name": "brand_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Brand Id" } }, { "in": "query", "name": "category_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Category Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_ProductSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Product List", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:read" ] } }, "post": { "operationId": "create_product_api_v1_products_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Product", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [ { "body_field": "variant_value_ids", "scopes": [ "catalog.product_variant:create" ], "when": "nonempty" } ], "required_scopes": [ "catalog.product:create" ] } } }, "/api/v1/products/{product_id}": { "delete": { "operationId": "delete_product_api_v1_products__product_id__delete", "parameters": [ { "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Product", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:delete" ] } }, "get": { "operationId": "product_detail_api_v1_products__product_id__get", "parameters": [ { "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_ProductDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Product Detail", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:read" ] } }, "patch": { "operationId": "update_product_api_v1_products__product_id__patch", "parameters": [ { "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Product", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [ { "body_field": "variant_value_ids", "scopes": [ "catalog.product_variant:create", "catalog.product_variant:update", "catalog.product_variant:delete" ], "when": "present" }, { "body_field": "variants_enabled", "scopes": [ "catalog.product_variant:update" ], "when": "present" } ], "required_scopes": [ "catalog.product:update" ] } } }, "/api/v1/products/{product_id}/variants": { "get": { "operationId": "variants_api_v1_products__product_id__variants_get", "parameters": [ { "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "active", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" } }, { "in": "query", "name": "sku", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "minLength": 1, "pattern": "^\\S+$", "type": "string" }, { "type": "null" } ], "title": "Sku" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_ProductVariantData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Variants", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:read" ] } }, "post": { "operationId": "create_variant_api_v1_products__product_id__variants_post", "parameters": [ { "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariantCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Variant", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_variant:create" ] } } }, "/api/v1/products/{product_id}/variants/{variant_id}": { "delete": { "operationId": "delete_variant_api_v1_products__product_id__variants__variant_id__delete", "parameters": [ { "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "path", "name": "variant_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Variant Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "query", "name": "expected_price_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 0, "title": "Expected Price Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Variant", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_variant:delete" ] } }, "get": { "operationId": "variant_api_v1_products__product_id__variants__variant_id__get", "parameters": [ { "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "path", "name": "variant_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Variant Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_ProductVariantData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Variant", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:read" ] } }, "patch": { "operationId": "update_variant_api_v1_products__product_id__variants__variant_id__patch", "parameters": [ { "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "path", "name": "variant_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Variant Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariantUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Variant", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_variant:update" ] } } }, "/api/v1/request-statuses": { "get": { "operationId": "request_statuses_api_v1_request_statuses_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequestType" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Request Statuses", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "returns.request:read" ] } } }, "/api/v1/requests": { "get": { "operationId": "request_list_api_v1_requests_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "number", "required": false, "schema": { "anyOf": [ { "maxLength": 48, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Number" } }, { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequestType" }, { "type": "null" } ], "title": "Type" } }, { "in": "query", "name": "status_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Status Id" } }, { "in": "query", "name": "order_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Order Id" } }, { "in": "query", "name": "order_number", "required": false, "schema": { "anyOf": [ { "maxLength": 48, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Order Number" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_RequestSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Request List", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "returns.request:read" ] } } }, "/api/v1/requests/{request_id}": { "get": { "operationId": "request_detail_api_v1_requests__request_id__get", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_RequestDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Request Detail", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "returns.request:read" ] } } }, "/api/v1/requests/{request_id}/refund-amount": { "patch": { "operationId": "adjust_request_refund_amount_api_v1_requests__request_id__refund_amount_patch", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Request Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundAmountUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Adjust Request Refund Amount", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "payments.request_refund:adjust_amount" ] } } }, "/api/v1/requests/{request_id}/status": { "patch": { "operationId": "change_request_status_api_v1_requests__request_id__status_patch", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Request Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestStatusUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Change Request Status", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "returns.request:update" ] } } }, "/api/v1/search/overview": { "get": { "operationId": "overview_api_v1_search_overview_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "enum": [ 7, 30, 90 ], "title": "Days", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse_OverviewData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Overview", "tags": [ "Search analytics" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.analytics:read" ] } } }, "/api/v1/search/queries": { "get": { "operationId": "queries_api_v1_search_queries_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "enum": [ 7, 30, 90 ], "title": "Days", "type": "integer" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "source", "required": false, "schema": { "anyOf": [ { "enum": [ "results", "autocomplete" ], "type": "string" }, { "type": "null" } ], "title": "Source" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "query", "required": false, "schema": { "default": "", "maxLength": 255, "title": "Query", "type": "string" } }, { "in": "query", "name": "searches_min", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Searches Min" } }, { "in": "query", "name": "searches_max", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Searches Max" } }, { "in": "query", "name": "clicks_min", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Clicks Min" } }, { "in": "query", "name": "clicks_max", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Clicks Max" } }, { "in": "query", "name": "zero_results_min", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Zero Results Min" } }, { "in": "query", "name": "zero_results_max", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Zero Results Max" } }, { "in": "query", "name": "zero_result_scope", "required": false, "schema": { "$ref": "#/components/schemas/ZeroResultScope", "default": "all" } }, { "in": "query", "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/QueryMetricSort", "default": "last_seen_desc" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse_list_MetricData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Queries", "tags": [ "Search analytics" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.analytics:read" ] } } }, "/api/v1/search/queries/{query_hash}": { "get": { "operationId": "occurrences_api_v1_search_queries__query_hash__get", "parameters": [ { "in": "path", "name": "query_hash", "required": true, "schema": { "pattern": "^[a-f0-9]{64}$", "title": "Query Hash", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "enum": [ 7, 30, 90 ], "title": "Days", "type": "integer" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "source", "required": false, "schema": { "anyOf": [ { "enum": [ "results", "autocomplete" ], "type": "string" }, { "type": "null" } ], "title": "Source" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse_list_OccurrenceData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Occurrences", "tags": [ "Search analytics" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.analytics:read" ] } } }, "/api/v1/search/rules": { "get": { "operationId": "rule_list_api_v1_search_rules_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "enabled", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, { "in": "query", "name": "name", "required": false, "schema": { "default": "", "maxLength": 160, "title": "Name", "type": "string" } }, { "in": "query", "name": "phrase", "required": false, "schema": { "default": "", "maxLength": 255, "title": "Phrase", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_RuleSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Rule List", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:read" ] } }, "post": { "operationId": "create_rule_api_v1_search_rules_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Rule", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:create" ] } } }, "/api/v1/search/rules/{rule_id}": { "delete": { "operationId": "delete_rule_api_v1_search_rules__rule_id__delete", "parameters": [ { "in": "path", "name": "rule_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Rule Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 2147483647, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Rule", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:delete" ] } }, "get": { "operationId": "rule_detail_api_v1_search_rules__rule_id__get", "parameters": [ { "in": "path", "name": "rule_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Rule Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_RuleDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Rule Detail", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:read" ] } }, "patch": { "operationId": "update_rule_api_v1_search_rules__rule_id__patch", "parameters": [ { "in": "path", "name": "rule_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Rule Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Rule", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:update" ] } } }, "/api/v1/variant-options": { "get": { "operationId": "collection_api_v1_variant_options_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_VariantOptionData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:read" ] } }, "post": { "operationId": "create_variant_option_api_v1_variant_options_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariantOptionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Variant Option", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:create" ] } } }, "/api/v1/variant-options/{identity}": { "delete": { "operationId": "delete_variant_option_api_v1_variant_options__identity__delete", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Variant Option", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:delete" ] } }, "get": { "operationId": "record_api_v1_variant_options__identity__get", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_VariantOptionData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:read" ] } }, "patch": { "operationId": "update_variant_option_api_v1_variant_options__identity__patch", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariantOptionUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Variant Option", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:update" ] } } }, "/api/v1/variant-options/{identity}/values": { "get": { "operationId": "values_api_v1_variant_options__identity__values_get", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_list_VariantValueData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Values", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:read" ] } }, "post": { "operationId": "create_variant_value_api_v1_variant_options__identity__values_post", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariantValueCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Variant Value", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:create" ] } } }, "/api/v1/variant-options/{identity}/values/{value_id}": { "delete": { "operationId": "delete_variant_value_api_v1_variant_options__identity__values__value_id__delete", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Variant Value", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:delete" ] } }, "get": { "operationId": "value_record_api_v1_variant_options__identity__values__value_id__get", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_VariantValueData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Value Record", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:read" ] } }, "patch": { "operationId": "update_variant_value_api_v1_variant_options__identity__values__value_id__patch", "parameters": [ { "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariantValueUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource version has changed.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Variant Value", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:update" ] } } } }, "x-shopently-errors": { "authentication.invalid_credentials": { "message": "The credentials are invalid.", "status": 401 }, "authentication.required": { "message": "Authentication is required.", "status": 401 }, "authorization.client_ip_unverified": { "message": "The client IP address could not be verified.", "status": 403 }, "authorization.ip_not_allowed": { "message": "Access from this IP address is not allowed.", "status": 403 }, "authorization.scope_denied": { "message": "The required permission has not been granted.", "status": 403 }, "capacity.queue_full": { "message": "The API is busy. Please retry shortly.", "status": 429 }, "capacity.wait_timeout": { "message": "The API could not start this request in time. Please retry shortly.", "status": 429 }, "entitlements.api_disabled": { "message": "API access is disabled for this store.", "status": 403 }, "entitlements.limit_exceeded": { "message": "The operation exceeds a plan limit.", "status": 403 }, "entitlements.operation_disabled": { "message": "The current plan does not allow this operation.", "status": 403 }, "entitlements.resource_blocked": { "message": "A plan limit blocks access to this resource.", "status": 403 }, "gateway.bad_response": { "message": "The API gateway could not obtain a valid response.", "status": 502 }, "gateway.timeout": { "message": "The API gateway timed out.", "status": 504 }, "idempotency.key_reused": { "message": "This idempotency key was used with a different request.", "status": 409 }, "internal.error": { "message": "An unexpected error occurred.", "status": 500 }, "rate_limit.exceeded": { "message": "The request rate limit has been exceeded.", "status": 429 }, "request.malformed": { "message": "The request could not be read.", "status": 400 }, "request.method_not_allowed": { "message": "This method is not supported for this resource.", "status": 405 }, "request.too_large": { "message": "The request exceeds the size limit.", "status": 413 }, "request.unsupported_media_type": { "message": "The request media type or encoding is not supported.", "status": 415 }, "request.validation_failed": { "message": "Some request parameters are invalid.", "status": 422 }, "resource.already_exists": { "message": "A resource with these unique values already exists.", "status": 409 }, "resource.in_use": { "message": "The resource is still in use.", "status": 409 }, "resource.not_found": { "message": "The resource was not found.", "status": 404 }, "resource.state_conflict": { "message": "The current resource state does not allow this operation.", "status": 409 }, "resource.version_conflict": { "message": "The resource version has changed.", "status": 409 }, "service.unavailable": { "message": "The API is temporarily unavailable.", "status": 503 } } }