openapi: 3.0.0 info: title: Customer API (current) version: v0 security: - newStoreAccessToken: [] servers: - url: https://dodici.x.newstore.net/v0/c paths: /categories: get: responses: '200': description: >- Array of top-level categories, including their children up to the requested level. content: application/json: schema: type: array title: Categories Response description: Get list of top-level categories items: type: object properties: name: type: string description: Category name. path: type: array description: >- category path beginning from root category, array sorted in correct order. items: type: string keywords: type: array description: keywords describing this category. items: type: string images: type: array items: type: object title: Category Image description: Information about a category image. properties: url: description: Category image url. type: string format: uri title: description: Category image title. type: string identifier: type: string description: Category image identifier (e.g. image-top-1). is_main: type: boolean description: >- Flag to identify the main image (for displaying purposes). alt_text: description: The alt tag value for the image. type: string dominant_color: type: string width: type: number multipleOf: 1 height: type: number multipleOf: 1 aspect_ratio: type: number multipleOf: 0.0001 tags: description: tenant specific tags for images e.g. is_main, ... type: array items: type: string position: type: integer description: >- position of this category in relation to categories on the same level in the category tree. description: type: string description: description of this category, e.g. for meta tags. extended_attributes: description: >- A collection of key/values for custom diversification of the category. type: array items: type: object required: - name - value properties: name: type: string value: type: string google_category: type: string description: >- The corresponding google category (numeric id), see http://www.google.com/basepages/producttype/taxonomy-with-ids.en-US.txt. children: description: Nested list of subcategories up to specified level. type: array items: description: A child category, same layout as parent category. type: object properties: name: type: string description: Category name. path: type: array description: >- category path beginning from root category, array sorted in correct order. items: type: string keywords: type: array description: keywords describing this category. items: type: string images: type: array items: type: object title: Category Image description: Information about a category image. properties: url: description: Category image url. type: string format: uri title: description: Category image title. type: string identifier: type: string description: >- Category image identifier (e.g. image-top-1). is_main: type: boolean description: >- Flag to identify the main image (for displaying purposes). alt_text: description: The alt tag value for the image. type: string dominant_color: type: string width: type: number multipleOf: 1 height: type: number multipleOf: 1 aspect_ratio: type: number multipleOf: 0.0001 tags: description: >- tenant specific tags for images e.g. is_main, ... type: array items: type: string position: type: integer description: >- position of this category in relation to categories on the same level in the category tree. description: type: string description: description of this category, e.g. for meta tags. extended_attributes: description: >- A collection of key/values for custom diversification of the category. type: array items: type: object required: - name - value properties: name: type: string value: type: string google_category: type: string description: >- The corresponding google category (numeric id), see http://www.google.com/basepages/producttype/taxonomy-with-ids.en-US.txt. children: description: >- Nested list of subcategories up to specified level. type: array items: type: object example: application/json: - name: Shoes path: - Shoes description: Shoe category position: 1 images: - url: >- https://example.com/tenant/102291/categories/shoes_01.jpg identifier: a5di5p34i2drwl is_main: true - url: >- https://example.com/tenant/102291/categories/shoes_02.jpg identifier: t3412423wien is_main: false - url: >- https://example.com/tenant/102291/categories/shoes_03.jpg identifier: ahsitn9353628 is_main: false extended_attribute: - name: my_property value: my_value - name: Necklaces path: - necklaces - accessories > necklaces description: Necklace category position: 2 images: - url: >- https://example.com/tenant/102291/categories/necklaces.jpg title: necklaces identifier: tahst39y523 is_main: true '206': description: | Same as 200 but indicating that the result set is not complete. This happens if there were more than 2000 categories found. content: application/json: schema: type: array title: Categories Response description: Get list of top-level categories items: type: object properties: name: type: string description: Category name. path: type: array description: >- category path beginning from root category, array sorted in correct order. items: type: string keywords: type: array description: keywords describing this category. items: type: string images: type: array items: type: object title: Category Image description: Information about a category image. properties: url: description: Category image url. type: string format: uri title: description: Category image title. type: string identifier: type: string description: Category image identifier (e.g. image-top-1). is_main: type: boolean description: >- Flag to identify the main image (for displaying purposes). alt_text: description: The alt tag value for the image. type: string dominant_color: type: string width: type: number multipleOf: 1 height: type: number multipleOf: 1 aspect_ratio: type: number multipleOf: 0.0001 tags: description: tenant specific tags for images e.g. is_main, ... type: array items: type: string position: type: integer description: >- position of this category in relation to categories on the same level in the category tree. description: type: string description: description of this category, e.g. for meta tags. extended_attributes: description: >- A collection of key/values for custom diversification of the category. type: array items: type: object required: - name - value properties: name: type: string value: type: string google_category: type: string description: >- The corresponding google category (numeric id), see http://www.google.com/basepages/producttype/taxonomy-with-ids.en-US.txt. children: description: Nested list of subcategories up to specified level. type: array items: description: A child category, same layout as parent category. type: object properties: name: type: string description: Category name. path: type: array description: >- category path beginning from root category, array sorted in correct order. items: type: string keywords: type: array description: keywords describing this category. items: type: string images: type: array items: type: object title: Category Image description: Information about a category image. properties: url: description: Category image url. type: string format: uri title: description: Category image title. type: string identifier: type: string description: >- Category image identifier (e.g. image-top-1). is_main: type: boolean description: >- Flag to identify the main image (for displaying purposes). alt_text: description: The alt tag value for the image. type: string dominant_color: type: string width: type: number multipleOf: 1 height: type: number multipleOf: 1 aspect_ratio: type: number multipleOf: 0.0001 tags: description: >- tenant specific tags for images e.g. is_main, ... type: array items: type: string position: type: integer description: >- position of this category in relation to categories on the same level in the category tree. description: type: string description: description of this category, e.g. for meta tags. extended_attributes: description: >- A collection of key/values for custom diversification of the category. type: array items: type: object required: - name - value properties: name: type: string value: type: string google_category: type: string description: >- The corresponding google category (numeric id), see http://www.google.com/basepages/producttype/taxonomy-with-ids.en-US.txt. children: description: >- Nested list of subcategories up to specified level. type: array items: type: object '400': description: Invalid request '404': description: Not found '500': description: Internal server error summary: List categories description: > Retrieves all top-level categories. A product category is product attribute that organizes products in a hierarchy. For example, a pair of trousers could belong to the following categories: `Men’s Clothing > Pants > Chinos` operationId: listCategories parameters: - name: depth in: query description: >- Specifies the depth of child categories to retrieve. When omitted, all categories are returned. schema: type: integer - name: locale in: query required: true description: >- A locale code. Can be used to fetch product information in different languages. schema: type: string - name: catalog in: query description: >- DEPRECATED. Use `shop` instead. The identifier of the product catalog. schema: type: string - name: shop in: query required: true description: The identifier of the shop the product belongs to. schema: type: string /consumers/{id}/orders: get: responses: '200': description: >- A collection of orders placed by the customer, in the order they were placed, newest order first. content: application/json: schema: type: object title: Consumer Orders List Response description: A paginated list of consumer orders required: - pagination_info - items allOf: - type: object description: Contains default fields for paginatable APIs. properties: pagination_info: type: object required: - count - total - offset - prev_url - next_url properties: count: description: Contains the count of the contained array. type: integer total: description: >- Contains the total count of documents. Will be null if the API is not able to determin a total count. type: integer nullable: true offset: description: Contains the current offset. type: integer prev_url: description: >- An URI that can be used to get the previous page. Will be null if the current page is the first page. type: string nullable: true format: uri next_url: description: >- An URI that can be used to get the next page. Will be null if the current page is the last page. type: string nullable: true format: uri - properties: items: type: array items: title: ConsumerOrder type: object required: - order_uuid - customer_uuid properties: order_uuid: description: UUID of the Order (an SO uuid). type: string maxLength: 36 minLength: 36 order_id: description: Human readable order ID. type: string maxLength: 256 channel: description: >- Specific identifier of the channel the SalesOrder was placed in, e.g. 'Giovanna Dodici US'. maxLength: 256 type: string channel_type: description: >- Type of the channel the SalesOrder was placed in, more general than channel, e.g. 'web' or 'mobile'. type: string maxLength: 256 external_order_id: description: Order identifier used in external system. type: string maxLength: 256 customer_uuid: description: UUID of the consumer who placed this Order. type: string maxLength: 36 minLength: 36 external_customer_id: description: Consumer Identifier used in external system. type: string maxLength: 256 created_at: description: the time when this row was created. type: string format: date-time created_by_label: type: string description: >- A string that shows the source the order comes from, i.e. NewStore app/Demandware/Retail Store/. taxation: type: string enum: - net - gross status_label: type: string status_description: type: string shipping_address: type: object title: Consumer address properties: id: type: string title: description: e.g. Dr., Prof., Pres., ... type: string suffix: description: e.g. Jr., Sr., III, ... type: string salutation: description: e.g. Mr., Ms., Mrs., ... type: string first_name: type: string second_name: type: string last_name: type: string address_line_1: type: string address_line_2: type: string province: type: string state: type: string zip_code: type: string city: type: string country_code: description: >- Country code for this address. Must be ISO-3166 reference. type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW phone: type: string billing_address: allOf: - type: object title: Consumer address properties: id: type: string title: description: e.g. Dr., Prof., Pres., ... type: string suffix: description: e.g. Jr., Sr., III, ... type: string salutation: description: e.g. Mr., Ms., Mrs., ... type: string first_name: type: string second_name: type: string last_name: type: string address_line_1: type: string address_line_2: type: string province: type: string state: type: string zip_code: type: string city: type: string country_code: description: >- Country code for this address. Must be ISO-3166 reference. type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW phone: type: string - properties: email: type: string payments: type: array items: description: >- Contains the payment information.Can be used for multiple payments against multiple credit sources (i.e. store credit + CC). type: object properties: uuid: description: UUID of the Payment. type: string maxLength: 36 minLength: 36 currency: type: string maxLength: 3 minLength: 3 method: type: string description: >- The method consumer paid for the order. (Credit Card/PayPal/ApplePay). payment_detail: type: string description: >- The type of card was used: . credit_card_number: type: string description: Last 4 digits, if available. nullable: true minLength: 4 maxLength: 4 instrument_id: type: string description: >- The unique identifier of the financial instrument. Newstore owns this identifier. status_label: type: string description: >- The latest status that every of the LOs has been in. (e.g. 1 order --> split into 2 LO. 1st LO in state `pending`, 2nd LO in `authorized` --> the value has to be `pending`. status_description: type: string description: >- The detailed description of the `status_label` field. (e.g. `Payment is pending against your credit card`). totals: type: object properties: merchandise_total: type: number description: >- sum of the products, so excluding shipping, handling, surcharges, etc. shipping_total: type: number description: sum of all shipping costs. shipping_taxes: type: number description: shipping taxes. taxes: type: number description: Total taxes for the order. order_total: type: number description: >- Total costs for the order w/o shipping costs. deprecated in favor of "grand_total" property. gift_wrapping_taxes: description: Gift-wrapping taxes. type: number gift_wrapping_total: description: Sum of all gift-wrapping costs. type: number grand_total: type: number description: >- Total costs for the order w/o shipping costs. currency: type: string minLength: 3 maxLength: 3 description: >- The currency this order was checked out with. shipments: type: array items: title: ConsumerOrder Product type: object properties: shipment_uuid: description: UUID of the shipment. type: string minLength: 36 maxLength: 36 shipping_from: description: >- Country code for this address. Must be ISO-3166 reference. type: string links: type: object properties: return_label: type: string description: >- A permalink to the return label pdf. DEPRECATED!!! When you are looking for return documents look into shipment->details->shipping_packages please. invoice: type: string description: A permalink to an Invoice pdf. sales_receipt: type: string description: >- A Document which is created through an In-Store purchase. price: description: >- accumulated prices for the shipment products. deprecated in favor of "totals" property. type: object properties: net: type: number tax: type: number gross: type: number base: type: number adjustment: type: number adjusted_total: type: number currency: type: string minLength: 3 maxLength: 3 description: The currency of this item. totals: type: object properties: merchandise_total: type: number description: >- sum of the products, so excluding shipping, handling, surcharges, etc. shipping_total: type: number description: sum of all shipping costs. shipping_taxes: type: number description: shipping taxes. taxes: type: number description: Total taxes for the order. order_total: type: number description: >- Total costs for the order w/o shipping costs. deprecated in favor of "grand_total" property. gift_wrapping_taxes: description: Gift-wrapping taxes. type: number gift_wrapping_total: description: Sum of all gift-wrapping costs. type: number grand_total: type: number description: >- Total costs for the order w/o shipping costs. currency: type: string minLength: 3 maxLength: 3 description: >- The currency this order was checked out with. details: type: object properties: carrier: type: string description: >- The carrier identifier, for example FEDEX or DELIV. This property is only filled for in-store fulfilled orders. You can also find the carrier in the details of the package ('shipping_package'). method: type: string description: ' the delivery method (e.g. Overnight Express).' delivery_forecast_at: type: string description: >- the approximated time when this shipments' delivery is planed. format: date-time delivery_status_label: enum: - Pending - Awaiting Pickup - Shipped - Delivered - Cancelled description: >- The label of the delivery status. This label displaying the details of a shipment. For DC orders, only the following labels are possible: 'Pending', 'Shipped' and 'Cancelled'. delivery_status_id: description: >- The id of the order status. For DC orders, only the following ids are possible: 'pending', 'shipped' and 'cancelled'. enum: - pending - awaiting_pickup - shipped - delivered - cancelled delivery_status_date: description: Last time StatusID was changed. type: string nullable: true format: date-time delivered_at: type: string nullable: true description: >- the time when this shipment was delivered. format: date-time shipping_packages: type: array items: type: object properties: shipment_id: description: >- Identifier of the shipment object created by external carrier API. maxLength: 256 type: string tracking_code: description: >- Tracking code received from external carrier API. maxLength: 256 type: string carrier: description: >- The carrier identifier. For example FEDEX or DELIV. type: string tracking_url: description: Tracking url to track the package. maxLength: 256 type: string format: uri delivery_from: type: string format: date-time description: >- Beginning of the time window for the delivery. delivery_to: type: string format: date-time description: End of the time window for the delivery. delivered_at: type: string format: date-time description: The time of the shipment delivery. product_ids: type: array items: type: string description: Id of product included in the package. links: type: object properties: return_label: type: string description: A permalink to the return label pdf. return_form: type: string description: A permalink to the return form pdf. items: type: array items: allOf: - type: object properties: id: type: string description: Identifier of the product. name: type: string description: Product name. image: type: string description: Link to the product image. price: allOf: - type: object properties: net: type: number tax: type: number gross: type: number base: type: number adjustment: type: number adjusted_total: type: number currency: type: string minLength: 3 maxLength: 3 description: The currency of this item. - properties: catalog: type: number description: >- Original price w/o discounts and for quantity 1 as stored in the product catalog. Value of this property could be w/ or w/o tax depends on tenant price catalog. category: type: string description: DEPRECATED. variation_color_value: type: string variation_size_value: type: string variation_attribute_1_value: type: string description: >- An additional variation selection, e.g. material variation_attribute_2_value: type: string description: >- An additional variation selection, e.g. material product_sku: type: string description: The sku of the product. extended_attributes: type: array items: type: object required: - name - value maxProperties: 2 properties: name: description: The name of the attribute. type: string value: description: The value of the attribute. type: string custom_attributes: description: >- DEPRECATED. Use extended_attributes instead. type: array items: type: object required: - name - value maxProperties: 2 properties: name: description: The name of the attribute. type: string value: description: The value of the attribute. type: string discounts: description: >- Information about discounts applied to the item. type: array items: title: Discount type: object description: >- Information about discounts applied to the item. required: - promotion_uuid - price_adjustment - action - value - level properties: promotion_uuid: description: >- ID of the discount rule that was applied. If no discount rule was applied (e.g. manual price adjustment), the value is a generated ID. type: string maxLength: 36 minLength: 36 price_adjustment: description: >- monetary amount that is subtracted from item price. type: number reason: description: >- Description of the promotion that was applied. type: string maxLength: 256 action: description: Type of promotion (percent, fix). type: string enum: - fixed - percentage value: description: >- Original discount value (percent or fix amount). type: number level: description: Discount level (item, order). type: string enum: - item - order - shipping coupon_code: description: Coupon code used for discount. type: string nullable: true maxLength: 256 external_ref: description: >- Reference to the discount in the external system. type: string maxLength: 256 - properties: quantity: type: integer minimum: 0 description: Quantity of the product. products: type: array items: type: object properties: id: type: string description: Identifier of the product. name: type: string description: Product name. image: type: string description: Link to the product image. price: allOf: - type: object properties: net: type: number tax: type: number gross: type: number base: type: number adjustment: type: number adjusted_total: type: number currency: type: string minLength: 3 maxLength: 3 description: The currency of this item. - properties: catalog: type: number description: >- Original price w/o discounts and for quantity 1 as stored in the product catalog. Value of this property could be w/ or w/o tax depends on tenant price catalog. category: type: string description: DEPRECATED. variation_color_value: type: string variation_size_value: type: string variation_attribute_1_value: type: string description: >- An additional variation selection, e.g. material variation_attribute_2_value: type: string description: >- An additional variation selection, e.g. material product_sku: type: string description: The sku of the product. extended_attributes: type: array items: type: object required: - name - value maxProperties: 2 properties: name: description: The name of the attribute. type: string value: description: The value of the attribute. type: string custom_attributes: description: >- DEPRECATED. Use extended_attributes instead. type: array items: type: object required: - name - value maxProperties: 2 properties: name: description: The name of the attribute. type: string value: description: The value of the attribute. type: string discounts: description: >- Information about discounts applied to the item. type: array items: title: Discount type: object description: >- Information about discounts applied to the item. required: - promotion_uuid - price_adjustment - action - value - level properties: promotion_uuid: description: >- ID of the discount rule that was applied. If no discount rule was applied (e.g. manual price adjustment), the value is a generated ID. type: string maxLength: 36 minLength: 36 price_adjustment: description: >- monetary amount that is subtracted from item price. type: number reason: description: >- Description of the promotion that was applied. type: string maxLength: 256 action: description: Type of promotion (percent, fix). type: string enum: - fixed - percentage value: description: >- Original discount value (percent or fix amount). type: number level: description: Discount level (item, order). type: string enum: - item - order - shipping coupon_code: description: Coupon code used for discount. type: string nullable: true maxLength: 256 external_ref: description: >- Reference to the discount in the external system. type: string maxLength: 256 returns: type: array items: type: object properties: return_id: type: string items: type: array items: type: object properties: product_id: type: string quantity: type: integer returned_at: description: time when return was done. type: string format: date-time return_code: description: >- Return code related to the return reason. type: integer return_reason: description: reason of the return. type: string refund_note: type: string description: A Permanent link to a RefundNote pdf. accounting_entity: description: Legal entity responsible for the shipment. type: object properties: id: description: internal identifier of the legal entity. type: string accounting_address: type: object title: Consumer address properties: id: type: string title: description: e.g. Dr., Prof., Pres., ... type: string suffix: description: e.g. Jr., Sr., III, ... type: string salutation: description: e.g. Mr., Ms., Mrs., ... type: string first_name: type: string second_name: type: string last_name: type: string address_line_1: type: string address_line_2: type: string province: type: string state: type: string zip_code: type: string city: type: string country_code: description: >- Country code for this address. Must be ISO-3166 reference. type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW phone: type: string store_address: type: object title: Store address description: >- The address the shipment gets shipped from. properties: address_line_1: type: string address_line_2: type: string province: type: string state: type: string zip_code: type: string maxLength: 32 city: type: string country_code: description: >- Country code for this address. Must be ISO-3166 reference. enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW latitude: type: number nullable: true longitude: type: number nullable: true discounts: description: >- Information about discounts applied to the item. type: array items: title: Discount type: object description: >- Information about discounts applied to the item. required: - promotion_uuid - price_adjustment - action - value - level properties: promotion_uuid: description: >- ID of the discount rule that was applied. If no discount rule was applied (e.g. manual price adjustment), the value is a generated ID. type: string maxLength: 36 minLength: 36 price_adjustment: description: >- monetary amount that is subtracted from item price. type: number reason: description: >- Description of the promotion that was applied. type: string maxLength: 256 action: description: Type of promotion (percent, fix). type: string enum: - fixed - percentage value: description: >- Original discount value (percent or fix amount). type: number level: description: Discount level (item, order). type: string enum: - item - order - shipping coupon_code: description: Coupon code used for discount. type: string nullable: true maxLength: 256 external_ref: description: >- Reference to the discount in the external system. type: string maxLength: 256 value_added_services: type: array items: title: value added service definition type: object properties: service_type: type: string description: the type of the value-added service. options: type: object description: options for the vas. price: type: object properties: net: type: number tax: type: number gross: type: number base: type: number adjustment: type: number adjusted_total: type: number currency: type: string minLength: 3 maxLength: 3 description: The currency of this item. ordered_products: type: array description: Original product data from the sales_order items: allOf: - type: object properties: id: type: string description: Identifier of the product. name: type: string description: Product name. image: type: string description: Link to the product image. price: allOf: - type: object properties: net: type: number tax: type: number gross: type: number base: type: number adjustment: type: number adjusted_total: type: number currency: type: string minLength: 3 maxLength: 3 description: The currency of this item. - properties: catalog: type: number description: >- Original price w/o discounts and for quantity 1 as stored in the product catalog. Value of this property could be w/ or w/o tax depends on tenant price catalog. category: type: string description: DEPRECATED. variation_color_value: type: string variation_size_value: type: string variation_attribute_1_value: type: string description: >- An additional variation selection, e.g. material variation_attribute_2_value: type: string description: >- An additional variation selection, e.g. material product_sku: type: string description: The sku of the product. extended_attributes: type: array items: type: object required: - name - value maxProperties: 2 properties: name: description: The name of the attribute. type: string value: description: The value of the attribute. type: string custom_attributes: description: >- DEPRECATED. Use extended_attributes instead. type: array items: type: object required: - name - value maxProperties: 2 properties: name: description: The name of the attribute. type: string value: description: The value of the attribute. type: string discounts: description: >- Information about discounts applied to the item. type: array items: title: Discount type: object description: >- Information about discounts applied to the item. required: - promotion_uuid - price_adjustment - action - value - level properties: promotion_uuid: description: >- ID of the discount rule that was applied. If no discount rule was applied (e.g. manual price adjustment), the value is a generated ID. type: string maxLength: 36 minLength: 36 price_adjustment: description: >- monetary amount that is subtracted from item price. type: number reason: description: >- Description of the promotion that was applied. type: string maxLength: 256 action: description: Type of promotion (percent, fix). type: string enum: - fixed - percentage value: description: >- Original discount value (percent or fix amount). type: number level: description: Discount level (item, order). type: string enum: - item - order - shipping coupon_code: description: Coupon code used for discount. type: string nullable: true maxLength: 256 external_ref: description: >- Reference to the discount in the external system. type: string maxLength: 256 - properties: quantity: type: integer minimum: 0 description: Quantity of the product. extended_attributes: type: array items: type: object required: - name - value maxProperties: 2 properties: name: description: The name of the attribute. type: string value: description: The value of the attribute. type: string summary: List order history description: > Returns the history of orders for the given customer (or consumer) stored in NewStore Cloud. Typically, customers are created automatically when they place an order online or when they provide their email address, during an in-store purchase. operationId: listOrderHistory parameters: - name: offset in: query description: The page offset. schema: default: 0 minimum: 0 type: integer - name: count in: query description: The number of requested documents. schema: default: 10 minimum: 1 type: integer x-annotation-cached: false parameters: - name: id in: path required: true schema: type: string description: Customer ID (uuid) /products: get: responses: '200': description: | The list of products. content: application/json: schema: type: object description: Contains a list of products for a given category path allOf: - type: object description: Contains default fields for paginatable APIs. properties: pagination_info: type: object required: - count - total - offset - prev_url - next_url properties: count: description: Contains the count of the contained array. type: integer total: description: >- Contains the total count of documents. Will be null if the API is not able to determin a total count. type: integer nullable: true offset: description: Contains the current offset. type: integer prev_url: description: >- An URI that can be used to get the previous page. Will be null if the current page is the first page. type: string nullable: true format: uri next_url: description: >- An URI that can be used to get the next page. Will be null if the current page is the last page. type: string nullable: true format: uri - type: object properties: items: type: array items: description: >- Data for Item in Product Listing (product with less information). type: object properties: product_id: type: string description: product identifier. is_available: type: boolean description: Set to true if the product can be purchased. title: description: The product title (product name). type: string images: description: Product images. type: array items: type: object title: Product Image description: All product images without color swatches. required: - url properties: url: description: Product image url. type: string format: uri title: description: Product image title. type: string identifier: type: string description: >- Product image identifier (e.g. image-top-1). is_main: type: boolean description: >- Flag to identify the main image (for displaying purposes). alt_text: description: The alt tag value for the image. type: string dominant_color: type: string description: dominant color in image as color hex. pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ width: type: number description: width of the image in pixel. multipleOf: 1 height: type: number description: height of the image in pixel. multipleOf: 1 aspect_ratio: type: number description: aspect ratio of the image (width/height). multipleOf: 0.0001 tags: type: array items: type: string preorder_start: description: >- Determines the date-time (inclusive) when the product is available for pre-order. type: string format: date-time example: '2020-03-16T05:00:14Z' online_from: description: >- Determines the date-time (inclusive) when the product is available for sale. type: string format: date-time example: '2021-01-01T17:00:00Z' online_to: description: >- Determines the date-time (inclusive) when the product is not available for sales anymore. type: string format: date-time example: '2021-12-01T10:01:00Z' price: description: >- product price shown to the consumer (can be incl. or excl. tax). type: number multipleOf: 0.01 currency_code: type: string description: >- The currency of this price as 3 character ISO-4217 code. Example USD, EUR. . markdown_price: description: special promotion product price. type: number multipleOf: 0.01 main_category_path: type: array items: type: string main_category_full_path: type: string description: >- a fully qualified main category path value that can be used to filter out products under the main category path. main_category_position: type: integer nullable: true description: position relative to the main category. material: type: string description: >- indicates the materials the product item is produced of. country_of_origin: type: string description: is the country of manufacture. product_hts_number: description: >- A six digit code specified by harmonized system for tariffs (required for international shipments). type: string schedule_b: type: string description: >- is a classification code for exporting goods out of the United States. The Schedule B is used to track the amount of trade goods that are being exported from the U.S. The U.S. Census Bureau keeps records of the amount of exports by country/quantity, and dollar amount. caption: description: A short version of the product description. type: string description: description: The product description. type: string extended_attributes: description: >- A collection of key/values for custom diversification of the product. type: array items: type: object required: - name - value properties: name: type: string value: type: string variations: description: >- product variant specific information. Fields that are equal in all variants are omitted and must be obtained from the main product. type: array items: type: object title: Product Variations description: >- All product attributes of other variants that are relevant to display product variations. properties: product_id: type: string description: >- product identifier to get the reference to the corresponding product. is_available: type: boolean description: True if product can be purchased. variation_color_value: type: string description: >- Product color display name (from import field variation_color_value). color_swatch: type: object title: Color Swatch description: >- A color swatch is a little image that depicts the product's color. properties: url: type: string format: uri description: color swatch image url. alt_text: type: string title: type: string dominant_color: type: string description: dominant color in image as color hex. pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ width: type: number description: width of the image in pixel. multipleOf: 1 height: type: number description: height of the image in pixel. multipleOf: 1 aspect_ratio: type: number description: >- aspect ratio of the image (width/height). multipleOf: 0.0001 variation_size_value: type: string description: >- product size display name (from import field variation_size_value). variation_size_gender: description: Gender for which the size will apply. type: string enum: - male - female - unisex - '' variation_size_type: description: the cut of the product. type: string variation_size_system: description: Size system code (non iso country code). type: string variation_additional_1_value: description: >- Value of first additional variation attribute. type: string variation_additional_2_value: description: >- Value of second additional variation attribute. type: string price: description: >- product price shown to the consumer (can be incl. or excl. tax). type: number multipleOf: 0.01 markdown_price: description: special promotion product price. type: number multipleOf: 0.01 is_preorder: type: boolean description: >- Set to true if product can be pre-ordered. This means that the product is in stock and a preorder_start date is set between the current date and the online_from date. serialized_inventory: description: >- Set to true if the product is tracked in the platform using serial numbers. type: boolean variable_pricing: description: >- Indicates that the price of this product is entered during checkout. type: boolean inventory_tracked: description: >- Indicates that the availability of this product is being tracked on the platform. type: boolean facets: type: array items: type: object properties: field: type: string description: Items field name that can be filtered with. type: type: string description: >- Type of the facet result e.g. 'enum' type indicates that the facet elements are simply enumerated and available as a list, as in a Color facet would have a list such as Blue, Green, Red etc values: type: array items: type: object properties: value: type: string description: Value of the field in the items. count: type: integer description: >- the count values currently represent the count of the variants and not the groups. So it might be better to just use this value to check for a count of 0. A facet value with count 0, might needs to be disabled for selection as filter option in the UI for example. '400': description: > The requested length of return set is greater than the maximum allowed. summary: List products description: Returns a list of products via the Search API. operationId: listProducts parameters: - name: path in: query description: > The path of the category to return products from. The value needs to be URL encoded. You can fetch subcategories as shown in the below examples: `All > Men > T-shirts > Rafa Tennis T-shirts` `All > Women > Hats > Burton Hats` schema: type: string example: All > Men > Tops - name: q in: query description: A search term to restrict products. schema: type: string - name: show_variations in: query description: Flag to return the `variations` field. schema: type: boolean - name: show_variation_attributes in: query description: Flag to return the `variation_attributes` field. schema: type: boolean - name: is_preorder in: query description: Flag to filter by `is_preorder`. schema: type: boolean - name: locale in: query required: true description: >- A locale code. Can be used to fetch product information in different languages. schema: type: string - name: catalog in: query description: >- DEPRECATED. Use `shop` instead. The identifier of the product catalog. schema: type: string - name: shop in: query required: true description: The identifier of the shop the product belongs to. schema: type: string - name: offset in: query description: The page offset. schema: default: 0 minimum: 0 type: integer - name: count in: query description: The number of requested documents. schema: default: 10 minimum: 1 type: integer - name: sort in: query description: >- Sorts the returned values. Takes two values separated by the pipe character (`|`), the field to sort and the sort order. schema: type: string - name: location_id in: query description: >- Use Stock on Hand values from this location using sorting or filtering by Stock on Hand. schema: type: string - name: min_soh in: query description: Minimum (inclusive) Stock on Hand. schema: type: integer - name: facetfilter[variation_size_value] in: query description: Comma-separated values of different sizes to match. schema: type: string - name: facetfilter[variation_color_value] in: query description: Comma-separated values of different colors to match. schema: type: string - name: facetfilter[] in: query description: >- Comma-separated values of different attribute values to apply. The name of the supported fields are in the [Import API](/newstore-cloud/catalog/import-api.html)'s `filterable_fields` property. schema: type: string /products/{type}{id}: get: responses: '200': description: | The product detail information if the provided id exists. content: application/json: schema: type: object properties: product_id: type: string description: product identifier. variant_group_id: type: string description: Identifier of variant group this product belongs to. is_available: type: boolean description: Set true if the product can be purchased. categories: type: array items: type: object properties: path: type: array items: type: string full_path: description: >- a fully qualified category path value that can be used to filter out products under a category path. type: string position: type: integer nullable: true description: position relative to this category. main_category_path: type: array items: type: string main_category_full_path: description: >- a fully qualified main category path value that can be used to filter out products under the main category path. type: string main_category_position: type: integer nullable: true description: position relative to the main category. external_identifiers: description: The product's identifiers. type: object properties: sku: type: string description: is the stock keeping unit identifier. gtin: type: string description: is the global trade item number. upc: type: string description: is the universal product code. ean13: type: string description: is the european article number. jan: type: string description: is the japanese article number. isbn: type: string description: is the international standard book number. additionalProperties: type: string extended_attributes: description: >- A collection of key/values for custom diversification of the product. type: array items: type: object required: - name - value properties: name: type: string value: type: string sku: type: string description: >- Stock keeping unit identifier. DEPRECATED: use external_identifiers sku field instead . title: description: The product title. type: string brand: description: The product brand name. type: string caption: description: A short version of the product description. type: string description: description: The product description. type: string keywords: description: A list of product keywords. type: array items: type: string images: description: Product images. type: array items: type: object title: Product Image description: All product images without color swatches. required: - url properties: url: description: Product image url. type: string format: uri title: description: Product image title. type: string identifier: type: string description: Product image identifier (e.g. image-top-1). is_main: type: boolean description: >- Flag to identify the main image (for displaying purposes). alt_text: description: The alt tag value for the image. type: string dominant_color: type: string description: dominant color in image as color hex. pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ width: type: number description: width of the image in pixel. multipleOf: 1 height: type: number description: height of the image in pixel. multipleOf: 1 aspect_ratio: type: number description: aspect ratio of the image (width/height). multipleOf: 0.0001 tags: type: array items: type: string gtin: description: >- Global Trade Item Number. Can be a UPC (universal product code), EAN (european article number), JAN (japanese article number) or ISBN. type: string template_id: type: string description: specific template for displaying the product. price: description: >- The product price displayed on the frontend apps (can be including or excluding tax).", type: number multipleOf: 0.01 currency_code: type: string description: >- The currency of this price as 3 character ISO-4217 code. Example USD, EUR. . tax_class_id: type: string preorder_start: description: >- Determines the date-time (inclusive) when the product is available for pre-order. type: string format: date-time example: '2020-03-16T05:00:14Z' online_from: description: >- Determines the date-time (inclusive) when the product is available for sale. type: string format: date-time example: '2021-01-01T17:00:00Z' online_to: description: >- Determines the date-time (inclusive) when the product is not available for sale anymore. type: string format: date-time example: '2021-12-01T10:01:00Z' variation_color_value: type: string description: >- Product color display name (from import field variation_color_value). color_swatch: type: object title: Color Swatch description: >- A color swatch is a little image that depicts the product's color. properties: url: type: string format: uri description: color swatch image url. alt_text: type: string title: type: string dominant_color: type: string description: dominant color in image as color hex. pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ width: type: number description: width of the image in pixel. multipleOf: 1 height: type: number description: height of the image in pixel. multipleOf: 1 aspect_ratio: type: number description: aspect ratio of the image (width/height). multipleOf: 0.0001 variation_size_value: type: string description: >- product size display name (from import field variation_size_value). variation_size_gender: description: Gender for which the size will apply. type: string enum: - male - female - unisex - '' variation_size_type: description: the cut of the product. type: string variation_size_system: description: Size system code (non iso country code). type: string variation_additional_1_value: description: Value of first additional variation attribute. type: string variation_additional_2_value: description: Value of second additional variation attribute. type: string markdown_price: description: special promotion product price. type: number multipleOf: 0.01 product_hts_number: description: >- A six digit code specified by harmonized system for tariffs (required for international shipments). type: string schedule_b: description: >- Classification number for exporting goods out of the United States (required for international shipments). type: string variation_attributes: type: object title: Product Variation Attributes description: >- All possible values of product attributes that generate product variations (e.g. color or size) in correct sort order. properties: variation_color_values: type: array items: type: string variation_size_values: type: array items: type: string variation_additional_1_name: description: Name of first additional variant generating attribute. type: string variation_additional_1_values: description: Values for additional variant generating attribute. type: array items: type: string variation_additional_2_name: description: >- Name of second additional variant generating attribute. type: string variation_additional_2_values: description: Values for additional variant generating attribute. type: array items: type: string variations: description: >- product variant specific information. Fields that are equal in all variants are omitted and must be obtained from the main product. type: array items: type: object title: Product Variations description: >- All product attributes of other variants that are relevant to display product variations. properties: product_id: type: string description: >- product identifier to get the reference to the corresponding product. is_available: type: boolean description: True if product can be purchased. variation_color_value: type: string description: >- Product color display name (from import field variation_color_value). color_swatch: type: object title: Color Swatch description: >- A color swatch is a little image that depicts the product's color. properties: url: type: string format: uri description: color swatch image url. alt_text: type: string title: type: string dominant_color: type: string description: dominant color in image as color hex. pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ width: type: number description: width of the image in pixel. multipleOf: 1 height: type: number description: height of the image in pixel. multipleOf: 1 aspect_ratio: type: number description: aspect ratio of the image (width/height). multipleOf: 0.0001 variation_size_value: type: string description: >- product size display name (from import field variation_size_value). variation_size_gender: description: Gender for which the size will apply. type: string enum: - male - female - unisex - '' variation_size_type: description: the cut of the product. type: string variation_size_system: description: Size system code (non iso country code). type: string variation_additional_1_value: description: Value of first additional variation attribute. type: string variation_additional_2_value: description: Value of second additional variation attribute. type: string price: description: >- product price shown to the consumer (can be incl. or excl. tax). type: number multipleOf: 0.01 markdown_price: description: special promotion product price. type: number multipleOf: 0.01 shipping_weight_value: description: The numeric value. type: number shipping_weight_unit: description: The chosen weight unit. enum: - g - kg - lb is_preorder: type: boolean description: >- Set to true if product can be pre-ordered. This means that the product is in stock and a preorder_start date is set between the current date and the online_from date. serialized_inventory: description: >- Set to true if the product is tracked in the platform using serial numbers. type: boolean variable_pricing: description: >- Indicates that the price of this product is entered during checkout. type: boolean inventory_tracked: description: >- Indicates that the availability of this product is being tracked on the platform. type: boolean '404': description: The provided product id does not exist. summary: Get product details description: > Returns product detail information including product variant specific information (prices, quantities, ...). operationId: getProductDetails parameters: - name: locale in: query required: true description: >- A locale code. Can be used to fetch product information in different languages. schema: type: string - name: catalog in: query description: >- DEPRECATED. Use `shop` instead. The identifier of the product catalog. schema: type: string - name: shop in: query required: true description: The identifier of the shop the product belongs to. schema: type: string parameters: - name: type in: path required: true schema: type: string description: > The type of the **external** ID. It must contain ``=``. The product ID is denoted by the ``id`` parameter. To use the internal ID, remove the ``type`` parameter (including the `=`). - name: id in: path required: true schema: type: string description: > The product identifier. By default, it must be the internal product ID. To use an external ID, set the `type` parameter. **Important**: When retrieving a product whose id contains special characters (reserved, unreserved, and escaped characters based on the [RFC guidelines](https://datatracker.ietf.org/doc/html/rfc3986), the value of the product ID must be encoded. For more information, see Section 2.1 in the RFC guidelines. - name: include_variations in: query description: >- Whether to include/populate the product's variations field or not. Variations are included by default. schema: type: boolean - name: show_hidden in: query required: false description: Return details even if the product is hidden in catalog listings. schema: type: boolean default: false /prices: get: responses: '200': description: OK content: application/json: schema: title: Product prices information description: List of product prices information required: - items properties: items: type: array items: type: object required: - product_id - value - currency_code - traits properties: product_id: type: string value: type: number nullable: true description: >- product price value, if product doesn't have a price in the given pricebook the return price will be null currency_code: type: string nullable: true description: > The currency of this price as 3 character ISO-4217 code. Example USD, EUR. traits: type: array items: type: string description: A trait of this pricebook. summary: Get prices description: Retrieves price information for a list of products. operationId: getPrices parameters: - name: product_id in: query required: true schema: type: array items: type: string - name: pricebook in: query required: true schema: type: string - name: catalog in: query description: >- DEPRECATED. Use `shop` instead. The identifier of the product catalog. schema: type: string - name: shop in: query required: true description: The identifier of the shop the product belongs to. schema: type: string /locales: get: responses: '200': description: OK content: application/json: schema: title: List of locales information description: List of locales information required: - locales properties: locales: type: array items: type: string summary: List locales description: Retrieves the locales/translations available in a given shop. operationId: listLocales parameters: - name: catalog in: query description: >- DEPRECATED. Use `shop` instead. The identifier of the product catalog. schema: type: string - name: shop in: query required: true description: The identifier of the shop the product belongs to. schema: type: string /currencies: get: responses: '200': description: OK content: application/json: schema: title: Product prices information description: List of currencies information properties: currency_codes: type: array items: type: string summary: List currencies description: Retrieves the currencies available in a given shop. operationId: listCurrencies parameters: - name: catalog in: query description: >- DEPRECATED. Use `shop` instead. The identifier of the product catalog. schema: type: string - name: shop in: query required: true description: The identifier of the shop the product belongs to. schema: type: string /shops: get: responses: '200': description: OK content: application/json: schema: type: array title: List Shops Response description: Get list of shop along with its locales and pricebooks items: type: object properties: id: type: string description: The shop's identifier/name locales: type: array description: The shop's list of locales. items: type: object properties: locale: type: string display_name: type: string description: A human readable version of the shop's id/name. is_master: type: boolean description: >- Determines whether this combination of shop and locale is considered the 'master' locale. pricebooks: type: array description: >- The shop's list of pricebooks along with its currency code. items: type: object properties: id: type: string currency_code: type: string summary: List shops description: > Retrieves all shops configured for your business, along with the associated locales and pricebooks. operationId: listShops /shops/{shop}: get: responses: '200': description: OK content: application/json: schema: type: object title: Shop Response description: A shop along with its locales and pricebooks properties: id: type: string description: The shop's identifier/name locales: type: array description: The shop's list of locales. items: type: object properties: locale: type: string display_name: type: string description: A human readable version of the shop's id/name. is_master: type: boolean description: >- Determines whether this combination of shop and locale is considered the 'master' locale. pricebooks: type: array description: >- The shop's list of pricebooks along with its currency code. items: type: object properties: id: type: string currency_code: type: string summary: Get shop description: > Retrieves the specified shop along with the associated locales and pricebooks. operationId: getShop parameters: - name: shop in: path required: true description: The identifier of the shop to be returned. schema: type: string components: schemas: {} responses: trait_Well_behaving_400: description: Invalid request trait_Well_behaving_404: description: Not found trait_Well_behaving_500: description: Internal server error parameters: trait_Paginated_offset: name: offset in: query description: The page offset. schema: default: 0 minimum: 0 type: integer trait_Paginated_count: name: count in: query description: The number of requested documents. schema: default: 10 minimum: 1 type: integer trait_Scoped_to_locale_locale: name: locale in: query required: true description: >- A locale code. Can be used to fetch product information in different languages. schema: type: string trait_Scoped_to_shop_catalog: name: catalog in: query description: DEPRECATED. Use `shop` instead. The identifier of the product catalog. schema: type: string trait_Scoped_to_shop_shop: name: shop in: query required: true description: The identifier of the shop the product belongs to. schema: type: string trait_Scoped_to_shop_shop_in_path: name: shop in: path required: true description: The identifier of the shop to be returned. schema: type: string trait_Sortable_sort: name: sort in: query description: >- Sorts the returned values. Takes two values separated by the pipe character (`|`), the field to sort and the sort order. schema: type: string trait_location_id: name: location_id in: query description: >- Use Stock on Hand values from this location using sorting or filtering by Stock on Hand. schema: type: string trait_minimum_soh: name: min_soh in: query description: Minimum (inclusive) Stock on Hand. schema: type: integer trait_Filterable_facetfilter[variation_size_value]: name: facetfilter[variation_size_value] in: query description: Comma-separated values of different sizes to match. schema: type: string trait_Filterable_facetfilter[variation_color_value]: name: facetfilter[variation_color_value] in: query description: Comma-separated values of different colors to match. schema: type: string trait_Filterable_facetfilter[]: name: facetfilter[] in: query description: >- Comma-separated values of different attribute values to apply. The name of the supported fields are in the [Import API](/newstore-cloud/catalog/import-api.html)'s `filterable_fields` property. schema: type: string examples: {} requestBodies: {} headers: {} securitySchemes: newStoreAccessToken: type: http scheme: bearer bearerFormat: JWT links: {} callbacks: {} x-annotation-crossOriginAllowed: true x-annotation-cached: true x-annotation-cacheExpiration: 30