{"note":"OpenAPI conversion -- returning structured metadata","name":"jumpseller-com","description":"Jumpseller API","version":"1.0.0","base_url":"https://api.jumpseller.com/v1","endpoints":186,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Jumpseller API\n@base https://api.jumpseller.com/v1\n@version 1.0.0\n@auth Bearer basic | ApiKey login in query | ApiKey authtoken in query | OAuth2\n@endpoints 186\n@hint download_for_search\n@toc store(3), hooks.json(2), hooks(3), jsapps.json(2), jsapps(2), products.json(2), products(52), categories.json(2), categories(4), orders.json(2), orders(13), appointments.json(1), appointments(2), fulfillments(7), fulfillments.json(2), order(1), pages.json(2), pages(10), customers.json(2), customers(14), customer_categories.json(2), customer_categories(6), promotions.json(2), promotions(3), payment_methods.json(2), payment_methods(2), shipping_methods.json(2), shipping_methods(3), locations.json(2), locations(3), custom_fields.json(2), custom_fields(8), checkout_custom_fields.json(2), checkout_custom_fields(3), countries.json(1), countries(4), taxes.json(2), taxes(4), carts(1), order_documents.json(1), products_locations.json(2), rates.json(1)\n\n@group store\n@endpoint GET /store/info.json\n@desc Retrieve Store Information.\n@optional {fields: str # Comma separated list of the fields to return. Allowed values: name, code, currency, country, timezone, email, hooks_token, url, subscription_plan, logo, weight_unit, fb_pixel_id, whatsapp_phone, mobile_app_version, subscription_status, checkout_version, address. Unknown values are ignored; if none is valid, all fields are returned.}\n@returns(200) {store: map{name: str, code: str, currency: str, country: str, timezone: str, email: str, hooks_token: str, url: str, subscription_plan: str, logo: str?, weight_unit: str?, fb_pixel_id: str?, whatsapp_phone: str?, mobile_app_version: str?, subscription_status: str, checkout_version: str, address: map?}} # OK\n\n@endpoint GET /store/languages.json\n@desc Retrieve Store Languages.\n@returns(200) {languages: [map]} # OK\n\n@endgroup\n\n@group hooks.json\n@endpoint GET /hooks.json\n@desc Retrieve all Hooks.\n@returns(200) An array of Hooks\n\n@endpoint POST /hooks.json\n@desc Create a new Hook.\n@optional {hook: map{name: str, event!: str, url!: str}}\n@returns(200) {hook: map{id: int(int32), name: str?, event: str, url: str, created_at: str(date-time), application_id: int?}} # OK\n@errors {400: Invalid JSON body, Hook data missing, or the Hook could not be saved (invalid or unreachable URL, duplicated URL, hooks limit reached)., 404: Invalid event., 429: Too many Hooks created in the last hour.}\n\n@endgroup\n\n@group hooks\n@endpoint GET /hooks/{id}.json\n@desc Retrieve a single Hook.\n@required {id: int(int32) # Id of the Hook}\n@returns(200) {hook: map{id: int(int32), name: str?, event: str, url: str, created_at: str(date-time), application_id: int?}} # OK\n@errors {404: Hook Not Found.}\n\n@endpoint PUT /hooks/{id}.json\n@desc Update a Hook.\n@required {id: int(int32) # Id of the Hook}\n@optional {hook: map{name: str, event!: str, url: str, enabled: bool}}\n@returns(200) {hook: map{id: int(int32), name: str?, event: str, url: str, created_at: str(date-time), application_id: int?}} # OK\n@errors {404: Hook not found, Hook belongs to another App, invalid event, or validation failed.}\n\n@endpoint DELETE /hooks/{id}.json\n@desc Delete an existing Hook.\n@required {id: int(int32) # Id of the Hook}\n@returns(200) {message: str} # OK\n@errors {404: Hook not found, or the Hook belongs to an installed App.}\n\n@endgroup\n\n@group jsapps.json\n@endpoint GET /jsapps.json\n@desc Retrieve all the Store's JsApps.\n@returns(200) OK\n@errors {404: No JsApps found for the store (or for the app when using an OAuth token).}\n\n@endpoint POST /jsapps.json\n@desc Create a Store JsApp.\n@required {app: map{url!: str, template!: str, element!: str}}\n@returns(200) {js_app: map{id: int(int32), url: str, template: str, element: str, application_id: int(int32)}} # OK\n@errors {400: Bad request, check your parameters.}\n@example_request {\"app\":{\"url\":\"https://test.url.com/\",\"template\":\"layout\",\"element\":\"body\"}}\n\n@endgroup\n\n@group jsapps\n@endpoint GET /jsapps/{id}.json\n@desc Retrieve the JsApps of a given app.\n@required {id: str # Code of the app (e.g. `my-app`), not a JsApp id.}\n@returns(200) OK\n@errors {403: Not authorized to access JsApps for this app., 404: App not found or no JsApps for this app.}\n\n@endpoint DELETE /jsapps/{id}.json\n@desc Delete an existing JsApp.\n@required {id: int(int32) # Id of the JsApp}\n@returns(200) {message: str} # OK\n@errors {403: Not authorized to delete this JsApp., 404: JsApp not found.}\n\n@endgroup\n\n@group products.json\n@endpoint GET /products.json\n@desc Retrieve all Products.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1., locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., fields: str(string) # Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, bundle_components, fields, currency, appointment_settings, appointment_location_id.}\n@returns(200) OK\n\n@endpoint POST /products.json\n@desc Create a new Product.\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., fields: str(string) # Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, bundle_components, fields, currency, appointment_settings, appointment_location_id., product: map{name!: str, description: str, page_title: str, meta_description: str, type: str, days_to_expire: int(int32), price!: num(float), appointment_settings: map, appointment_location_id: int(int32), weight: num(float), stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, back_in_stock_enabled: bool, cost_per_item: num, compare_at_price: num, minimum_quantity: num, maximum_quantity: num, sku: str, barcode: str, google_product_category_text: str, quotable: bool, featured: bool, shipping_required: bool, status: str, package_format: str, length: num(float), width: num(float), height: num(float), diameter: num(float), categories: [map], variants: [map], brand: str, reviews_enabled: bool, google_product_category: str}}\n@returns(200) {product: map{id: int(int32), name: str, page_title: str, description: str, type: str, days_to_expire: int(int32)?, price: num(float), discount: num(float), weight: num(float), stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, back_in_stock_enabled: bool, cost_per_item: num?, compare_at_price: num?, sku: str, brand: str, barcode: str, google_product_category_text: str, quotable: bool, featured: bool, reviews_enabled: bool, status: str, created_at: str, updated_at: str, package_format: str, length: num(float), width: num(float), height: num(float), diameter: num(float), permalink: str, categories: [map], images: [map], variants: [map], bundle_components: [map], meta_description: str, shipping_required: bool, google_product_category: str?, fields: [map], currency: str, appointment_settings: map?, appointment_location_id: int(int32)?}} # OK\n@errors {400: Invalid product data (e.g. invalid type, appointment settings or variant options)., 404: Category, option or variant not found, or the Product could not be saved.}\n\n@endgroup\n\n@group products\n@endpoint GET /products/count.json\n@desc Count all Products.\n@returns(200) {count: int(int32)} # OK\n\n@endpoint GET /products/after/{id}.json\n@desc Retrieve Products after the given id.\n@required {id: int(int32) # Only Products with an id greater than this one are returned}\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., fields: str(string) # Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, bundle_components, fields, currency, appointment_settings, appointment_location_id., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) OK\n@errors {404: Locale Not Found.}\n\n@endpoint GET /products/status/{status}.json\n@desc Retrieve Products filtered by status.\n@required {status: str(available/not-available/disabled) # Status of the Product used as filter}\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., fields: str(string) # Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, bundle_components, fields, currency, appointment_settings, appointment_location_id., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) OK\n@errors {404: Status Invalid.}\n\n@endpoint GET /products/category/{category_id}.json\n@desc Retrieve Products filtered by category.\n@required {category_id: int(int32) # Category ID of the Product used as filter}\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., fields: str(string) # Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, bundle_components, fields, currency, appointment_settings, appointment_location_id., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) OK\n@errors {404: Category Not Found.}\n\n@endpoint GET /products/status/{status}/count.json\n@desc Count Products filtered by status.\n@required {status: str(available/not-available/disabled) # Status of the Product used as filter}\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language.}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Status Invalid.}\n\n@endpoint GET /products/category/{category_id}/count.json\n@desc Count Products filtered by category.\n@required {category_id: int(int32) # Category ID of the Product used as filter}\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language.}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Category Not Found.}\n\n@endpoint GET /products/{id}/reviews.json\n@desc Retrieve all reviews for a specific Product.\n@required {id: int(int32) # Id of the Product}\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) OK\n@errors {404: Product Not Found.}\n\n@endpoint GET /products/{id}/appointment_timeslots.json\n@desc Retrieve available appointment timeslots for a Product.\n@required {id: int(int32) # Id of the Product, start_date: str(date) # Inclusive lower boundary of the date range to check., end_date: str(date) # Inclusive upper boundary of the date range to check. Limited to 31 days after `start_date`.}\n@returns(200) A map of dates to their available timeslots.\n@errors {400: Invalid date range, or the Product is not an appointment Product., 404: Product Not Found.}\n\n@endpoint GET /products/reviews/{review_id}.json\n@desc Retrieve a single Product Review.\n@required {review_id: int}\n@returns(200) {review: map{id: int, status: str, rating: int, review: str, date: str, product_id: int, product_name: str?, order_id: int?, customer_email: str(email)?}} # OK\n@errors {404: Review Not Found.}\n\n@endpoint GET /products/reviews.json\n@desc Retrieve all Product Reviews.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) OK\n\n@endpoint GET /products/{id}.json\n@desc Retrieve a single Product.\n@required {id: int(int32) # Id of the Product}\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., fields: str(string) # Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, bundle_components, fields, currency, appointment_settings, appointment_location_id.}\n@returns(200) {product: map{id: int(int32), name: str, page_title: str, description: str, type: str, days_to_expire: int(int32)?, price: num(float), discount: num(float), weight: num(float), stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, back_in_stock_enabled: bool, cost_per_item: num?, compare_at_price: num?, sku: str, brand: str, barcode: str, google_product_category_text: str, quotable: bool, featured: bool, reviews_enabled: bool, status: str, created_at: str, updated_at: str, package_format: str, length: num(float), width: num(float), height: num(float), diameter: num(float), permalink: str, categories: [map], images: [map], variants: [map], bundle_components: [map], meta_description: str, shipping_required: bool, google_product_category: str?, fields: [map], currency: str, appointment_settings: map?, appointment_location_id: int(int32)?}} # OK\n@errors {404: Product Not Found.}\n\n@endpoint PUT /products/{id}.json\n@desc Modify an existing Product.\n@required {id: int(int32) # Id of the Product}\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., fields: str(string) # Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, bundle_components, fields, currency, appointment_settings, appointment_location_id., product: map{name: str, description: str, page_title: str, meta_description: str, type: str, days_to_expire: int(int32), price: num(float), appointment_settings: map, appointment_location_id: int(int32), weight: num(float), stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, back_in_stock_enabled: bool, cost_per_item: num, compare_at_price: num, minimum_quantity: num, maximum_quantity: num, sku: str, barcode: str, google_product_category_text: str, quotable: bool, featured: bool, shipping_required: bool, status: str, package_format: str, length: num(float), width: num(float), height: num(float), diameter: num(float), permalink: str, categories: [map], variants: [map], brand: str, reviews_enabled: bool, google_product_category: str}}\n@returns(200) {product: map{id: int(int32), name: str, page_title: str, description: str, type: str, days_to_expire: int(int32)?, price: num(float), discount: num(float), weight: num(float), stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, back_in_stock_enabled: bool, cost_per_item: num?, compare_at_price: num?, sku: str, brand: str, barcode: str, google_product_category_text: str, quotable: bool, featured: bool, reviews_enabled: bool, status: str, created_at: str, updated_at: str, package_format: str, length: num(float), width: num(float), height: num(float), diameter: num(float), permalink: str, categories: [map], images: [map], variants: [map], bundle_components: [map], meta_description: str, shipping_required: bool, google_product_category: str?, fields: [map], currency: str, appointment_settings: map?, appointment_location_id: int(int32)?}} # OK\n@errors {400: Invalid product data (e.g. invalid type or appointment settings)., 404: Product Not Found.}\n\n@endpoint DELETE /products/{id}.json\n@desc Delete an existing Product.\n@required {id: int(int32) # Id of the Product}\n@returns(200) {message: str} # OK\n@errors {400: The Product could not be deleted., 404: Product Not Found.}\n\n@endpoint GET /products/search.json\n@desc Retrieve a Product List from a query.\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., query: str(string) # Text to query for the Product. When omitted, all Products matching the other filters are returned., fields: str(string) # Comma separated values of the fields to search in. Allowed values: name, brand, description, sku, barcode, variants_sku, variants_barcode, option_name, categories, custom_fields, custom_field_selects. Defaults to all of them. The same list also restricts the Product fields returned in the response (e.g. `fields=name,sku` returns only name and sku)., status: str(string)(available/not-available/disabled/featured) # Product Status to query for the Product, categories: str(string) # Comma separated values of the Category IDs to query for the Product, order: str(price-asc/price-desc/position-asc/position-desc/date-asc/date-desc) # Sorting order of the results, limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of products\n@errors {400: Invalid status, categories or order.}\n\n@endpoint GET /products/{id}/options.json\n@desc Retrieve all Product Options.\n@required {id: int(int32) # Id of the Product}\n@returns(200) OK\n@errors {404: Product Not Found.}\n\n@endpoint POST /products/{id}/options.json\n@desc Create a new Product Option.\n@required {id: int(int32) # Id of the Product}\n@optional {option: map{name!: str, option_type: str, addon_price: num(float)} # If an option with the same name already exists in the store it is added to the product instead of creating a new one.}\n@returns(200) {option: map{id: int(int32), name: str, position: int(int32), option_type: str, addon_price: num(float)?, values: [map]}} # OK\n@errors {400: Option and Color options are not valid for an Appointment., 404: Product Not Found, Product Option name missing or Product Option could not be saved.}\n\n@endpoint GET /products/{id}/options/count.json\n@desc Count all Product Options.\n@required {id: int(int32) # Id of the Product}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Product Not Found.}\n\n@endpoint GET /products/{id}/options/{option_id}.json\n@desc Retrieve a single Product Option.\n@required {id: int(int32) # Id of the Product, option_id: int(int32) # Id of the Product Option}\n@returns(200) {option: map{id: int(int32), name: str, position: int(int32), option_type: str, addon_price: num(float)?, values: [map]}} # OK\n@errors {404: Product or Product Option Not Found.}\n\n@endpoint PUT /products/{id}/options/{option_id}.json\n@desc Modify an existing Product Option.\n@required {id: int(int32) # Id of the Product, option_id: int(int32) # Id of the Product Option}\n@optional {option: map{name: str, position: int(int32), option_type: str, addon_price: num(float), filters_visibility: bool}}\n@returns(200) {option: map{id: int(int32), name: str, position: int(int32), option_type: str, addon_price: num(float)?, values: [map]}} # OK\n@errors {404: Product or Product Option Not Found.}\n\n@endpoint DELETE /products/{id}/options/{option_id}.json\n@desc Delete a Product Option.\n@required {id: int(int32) # Id of the Product, option_id: int(int32) # Id of the Product Option}\n@returns(200) {message: str} # OK\n@errors {404: Product or Product Option Not Found.}\n\n@endpoint GET /products/{id}/options/{option_id}/values.json\n@desc Retrieve all Product Option Values.\n@required {id: int(int32) # Id of the Product, option_id: int(int32) # ID of the Product Option}\n@returns(200) OK\n@errors {404: Product or Product Option Not Found.}\n\n@endpoint POST /products/{id}/options/{option_id}/values.json\n@desc Create a new Product Option Value.\n@required {id: int(int32) # Id of the Product, option_id: int(int32) # Id of the Product Option}\n@optional {value: map{name: str, position: int(int32), custom: str}}\n@returns(200) {value: map{id: int(int32), name: str, custom: str, position: int(int32), product_option: map{id: int(int32), name: str, option_type: str}, variants: [map]}} # OK\n@errors {400: Variant limit exceeded., 404: Product or Product Option Not Found, name missing or invalid hex color value.}\n\n@endpoint GET /products/{id}/options/{option_id}/values/count.json\n@desc Count all Product Option Values.\n@required {id: int(int32) # Id of the Product, option_id: int(int32) # ID of the Product Option}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Product or Product Option Not Found.}\n\n@endpoint GET /products/{id}/options/{option_id}/values/{value_id}.json\n@desc Retrieve a single Product Option Value.\n@required {id: int(int32) # Id of the Product, option_id: int(int32) # Id of the Product Option, value_id: int(int32) # ID of the Product Option Value}\n@returns(200) {value: map{id: int(int32), name: str, custom: str, position: int(int32), product_option: map{id: int(int32), name: str, option_type: str}, variants: [map]}} # OK\n@errors {404: Product, Product Option or Product Option Value Not Found.}\n\n@endpoint PUT /products/{id}/options/{option_id}/values/{value_id}.json\n@desc Modify an existing Product Option Value.\n@required {id: int(int32) # Id of the Product, option_id: int(int32) # Id of the Product Option, value_id: int(int32) # Id of the Product Option Value}\n@optional {value: map{name: str, position: int(int32), custom: str}}\n@returns(200) {value: map{id: int(int32), name: str, custom: str, position: int(int32), product_option: map{id: int(int32), name: str, option_type: str}, variants: [map]}} # OK\n@errors {404: Product, Product Option or Product Option Value Not Found.}\n\n@endpoint DELETE /products/{id}/options/{option_id}/values/{value_id}.json\n@desc Delete a Product Option Value.\n@required {id: int(int32) # Id of the Product, option_id: int(int32) # Id of the Product Option, value_id: int(int32) # ID of the Product Option Value}\n@returns(200) {message: str} # OK\n@errors {404: Product, Product Option or Product Option Value Not Found.}\n\n@endpoint GET /products/{id}/variants/{variant_id}.json\n@desc Retrieve a single Product Variant.\n@required {id: int(int32) # Id of the Product, variant_id: int(int32) # Id of the Product Variant}\n@optional {fields: str(string) # Comma separated values of the fields to return for the Product Variant. Allowed values: id, position, price, cost_per_item, compare_at_price, sku, barcode, stock, stock_unlimited, stock_threshold, stock_notification, weight, options, image, discount.}\n@returns(200) {variant: map{id: int(int32), position: int(int32), created_at: str, updated_at: str, price: num(float), sku: str, barcode: str, stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, cost_per_item: num?, compare_at_price: num?, options: [map], image: map{id: int(int32), position: int(int32), url: str}, weight: num(float), discount: num}} # OK\n@errors {404: Product or Product Variant Not Found.}\n\n@endpoint PUT /products/{id}/variants/{variant_id}.json\n@desc Modify an existing Product Variant.\n@required {id: int(int32) # Id of the Product, variant_id: int(int32) # Id of the Product Variant}\n@optional {fields: str(string) # Comma separated values of the fields to return for the Product Variant. Allowed values: id, position, price, cost_per_item, compare_at_price, sku, barcode, stock, stock_unlimited, stock_threshold, stock_notification, weight, options, image, discount., variant: map{price: num(float), sku: str, barcode: str, stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, cost_per_item: num, compare_at_price: num, image_id: int(int32), options: [map], weight: num(float)}}\n@returns(200) {variant: map{id: int(int32), position: int(int32), created_at: str, updated_at: str, price: num(float), sku: str, barcode: str, stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, cost_per_item: num?, compare_at_price: num?, options: [map], image: map{id: int(int32), position: int(int32), url: str}, weight: num(float), discount: num}} # OK\n@errors {404: Product or Product Variant Not Found.}\n\n@endpoint GET /products/{id}/variants.json\n@desc Retrieve all Product Variants.\n@required {id: int(int32) # Id of the Product}\n@optional {fields: str(string) # Comma separated values of the fields to return for the Product Variant. Allowed values: id, position, price, cost_per_item, compare_at_price, sku, barcode, stock, stock_unlimited, stock_threshold, stock_notification, weight, options, image, discount.}\n@returns(200) OK\n@errors {404: Product or Product Variants Not Found.}\n\n@endpoint POST /products/{id}/variants.json\n@desc Create a new Product Variant.\n@required {id: int(int32) # Id of the Product}\n@optional {fields: str(string) # Comma separated values of the fields to return for the Product Variant. Allowed values: id, position, price, cost_per_item, compare_at_price, sku, barcode, stock, stock_unlimited, stock_threshold, stock_notification, weight, options, image, discount., variant: map{price: num(float), sku: str, barcode: str, stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, cost_per_item: num, compare_at_price: num, image_id: int(int32), options: [map], weight: num(float)}}\n@returns(200) {variant: map{id: int(int32), position: int(int32), created_at: str, updated_at: str, price: num(float), sku: str, barcode: str, stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, cost_per_item: num?, compare_at_price: num?, options: [map], image: map{id: int(int32), position: int(int32), url: str}, weight: num(float), discount: num}} # OK\n@errors {400: Variant limit exceeded or invalid options for an Appointment., 404: Product Not Found, options missing or no Product Variant matches the given options.}\n\n@endpoint GET /products/{id}/variants/count.json\n@desc Count all Product Variants.\n@required {id: int(int32) # Id of the Product}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Product Not Found.}\n\n@endpoint GET /products/{id}/images.json\n@desc Retrieve all Product Images.\n@required {id: int(int32) # Id of the Product}\n@returns(200) OK\n@errors {404: Product Not Found.}\n\n@endpoint POST /products/{id}/images.json\n@desc Create a new Product Image.\n@required {id: int(int32) # Id of the Product}\n@optional {image: map{url!: str, position: int(int32)}}\n@returns(200) {image: map{id: int(int32), position: int(int32), url: str}} # OK\n@errors {403: Storage limit reached., 404: Product or URL Not Found., 422: The image file is incomplete or damaged.}\n\n@endpoint GET /products/{id}/images/count.json\n@desc Count all Product Images.\n@required {id: int(int32) # Id of the Product}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Product Not Found.}\n\n@endpoint GET /products/{id}/images/{image_id}.json\n@desc Retrieve a single Product Image.\n@required {id: int(int32) # Id of the Product, image_id: int(int32) # Id of the Product Image}\n@returns(200) {image: map{id: int(int32), position: int(int32), url: str}} # OK\n@errors {404: Product or Image Not Found.}\n\n@endpoint DELETE /products/{id}/images/{image_id}.json\n@desc Delete a Product Image.\n@required {id: int(int32) # Id of the Product, image_id: int(int32) # Id of the Product Image}\n@returns(200) {message: str} # OK\n@errors {404: Product or Image Not Found.}\n\n@endpoint PUT /products/{id}/images/{image_id}.json\n@desc Update a Product Image position.\n@required {id: int(int32) # Id of the Product, image_id: int(int32) # Id of the Product Image, position: int(int32) # Desired position of the Product Image}\n@returns(200) {message: str} # OK\n@errors {404: Product or Image Not Found, or invalid position.}\n\n@endpoint GET /products/{id}/attachments.json\n@desc Retrieve all Product Attachments.\n@required {id: int(int32) # Id of the Product}\n@returns(200) OK\n@errors {404: Product Not Found.}\n\n@endpoint POST /products/{id}/attachments.json\n@desc Create a new Product Attachment.\n@required {id: int(int32) # Id of the Product}\n@optional {attachment: map{filename!: str, url!: str}}\n@returns(200) {attachment: map{id: int(int32), url: str}} # OK\n@errors {403: Attachment size limit exceeded., 404: Product Not Found, URL or filename missing, or the file could not be downloaded.}\n\n@endpoint GET /products/{id}/attachments/count.json\n@desc Count all Product Attachments.\n@required {id: int(int32) # Id of the Product}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Product Not Found.}\n\n@endpoint GET /products/{id}/attachments/{attachment_id}.json\n@desc Retrieve a single Product Attachment.\n@required {id: int(int32) # Id of the Product, attachment_id: int(int32) # Id of the Product Attachment}\n@returns(200) {attachment: map{id: int(int32), url: str}} # OK\n@errors {404: Product or Attachment Not Found.}\n\n@endpoint DELETE /products/{id}/attachments/{attachment_id}.json\n@desc Delete a Product Attachment.\n@required {id: int(int32) # Id of the Product, attachment_id: int(int32) # Id of the Product Attachment}\n@returns(200) {message: str} # OK\n@errors {404: Product or Attachment Not Found.}\n\n@endpoint GET /products/{id}/digital_products.json\n@desc Retrieve all Product DigitalProducts.\n@required {id: int(int32) # Id of the Product}\n@returns(200) OK\n@errors {404: Product Not Found.}\n\n@endpoint POST /products/{id}/digital_products.json\n@desc Create a new Product DigitalProduct.\n@required {id: int(int32) # Id of the Product}\n@optional {digital_product: map{filename: str, url!: str, external: bool}}\n@returns(200) {digital_product: map{id: int(int32), private_url: str, expiration_seconds: int(int32), external: bool}} # OK\n@errors {403: Plan without access to digital products, or file size limit exceeded., 404: Product Not Found, URL or filename missing, or the file could not be downloaded.}\n\n@endpoint GET /products/{id}/digital_products/count.json\n@desc Count all Product DigitalProducts.\n@required {id: int(int32) # Id of the Product}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Product Not Found.}\n\n@endpoint GET /products/{id}/digital_products/{digital_product_id}.json\n@desc Retrieve a single Product DigitalProduct.\n@required {id: int(int32) # Id of the Product, digital_product_id: int(int32) # Id of the Product DigitalProduct}\n@optional {external: str # true if searching for an external link}\n@returns(200) {digital_product: map{id: int(int32), private_url: str, expiration_seconds: int(int32), external: bool}} # OK\n@errors {404: Product or Digital Product Not Found.}\n\n@endpoint DELETE /products/{id}/digital_products/{digital_product_id}.json\n@desc Delete a Product DigitalProduct.\n@required {id: int(int32) # Id of the Product, digital_product_id: int(int32) # Id of the Product DigitalProduct}\n@optional {external: bool=false # true if it's an external link. If not present or false, it's a file}\n@returns(200) {message: str} # OK\n@errors {404: Product or Digital Product Not Found.}\n\n@endpoint GET /products/{id}/fields.json\n@desc Retrieve all Product Custom Fields.\n@required {id: int(int32) # Id of the Product}\n@returns(200) {fields: [map]} # OK\n@errors {404: Product Not Found, or the Product doesn't have custom field values.}\n\n@endpoint POST /products/{id}/fields.json\n@desc Add an existing Custom Field to a Product.\n@required {id: int(int32) # Id of the Product}\n@optional {fields: str(string) # Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, bundle_components, fields, currency, appointment_settings, appointment_location_id., field: map{id!: int(int32), value!: str, variants: [int]}}\n@returns(200) {product: map{id: int(int32), name: str, page_title: str, description: str, type: str, days_to_expire: int(int32)?, price: num(float), discount: num(float), weight: num(float), stock: int(int32), stock_unlimited: bool, stock_threshold: int(int32), stock_notification: bool, back_in_stock_enabled: bool, cost_per_item: num?, compare_at_price: num?, sku: str, brand: str, barcode: str, google_product_category_text: str, quotable: bool, featured: bool, reviews_enabled: bool, status: str, created_at: str, updated_at: str, package_format: str, length: num(float), width: num(float), height: num(float), diameter: num(float), permalink: str, categories: [map], images: [map], variants: [map], bundle_components: [map], meta_description: str, shipping_required: bool, google_product_category: str?, fields: [map], currency: str, appointment_settings: map?, appointment_location_id: int(int32)?}} # OK\n@errors {404: Product, Custom Field or Custom Field Select Option Not Found, or value missing.}\n\n@endpoint GET /products/{id}/fields/count.json\n@desc Count all Product Custom Fields.\n@required {id: int(int32) # Id of the Product}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Product Not Found.}\n\n@endgroup\n\n@group categories.json\n@endpoint GET /categories.json\n@desc Retrieve all Categories.\n@optional {fields: str(string) # Comma separated values of the fields to query for the Category. Allowed values: id, name, description, parent_id, permalink, images, products.}\n@returns(200) OK\n\n@endpoint POST /categories.json\n@desc Create a new Category.\n@optional {category: map{name!: str, parent_id: int(int32)}}\n@returns(200) {category: map{id: int(int32), name: str, description: str?, parent_id: int(int32)?, permalink: str, images: [map], products: [map]}} # OK\n@errors {400: Invalid parent_id., 404: Could not save Category.}\n\n@endgroup\n\n@group categories\n@endpoint GET /categories/count.json\n@desc Count all Categories.\n@returns(200) {count: int(int32)} # OK\n\n@endpoint GET /categories/{id}.json\n@desc Retrieve a single Category.\n@required {id: int(int32) # Id of the Category}\n@optional {fields: str(string) # Comma separated values of the fields to query for the Category. Allowed values: id, name, description, parent_id, permalink, images, products.}\n@returns(200) {category: map{id: int(int32), name: str, description: str?, parent_id: int(int32)?, permalink: str, images: [map], products: [map]}} # The selected Category.\n@errors {404: Category Not Found.}\n\n@endpoint PUT /categories/{id}.json\n@desc Modify an existing Category.\n@required {id: int(int32) # Id of the Category}\n@optional {category: map{name: str, default_order: str, description: str, filters_visibility: bool, not_recommendable: bool, parent_id: int(int32), permalink: str, page_title: str, meta_description: str}}\n@returns(200) {category: map{id: int(int32), name: str, description: str?, parent_id: int(int32)?, permalink: str, images: [map], products: [map]}} # OK\n@errors {400: Permalink must not start with a locale., 404: Category Not Found or could not be saved.}\n\n@endpoint DELETE /categories/{id}.json\n@desc Delete an existing Category.\n@required {id: int(int32) # Id of the Category}\n@returns(200) {message: str} # OK\n@errors {404: Category Not Found.}\n\n@endgroup\n\n@group orders.json\n@endpoint GET /orders.json\n@desc Retrieve all Orders.\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., status_filters: str # Order statuses to filter by. Send comma-separated values (`status_filters=paid,canceled`) or repeat the parameter as an array (`status_filters[]=paid&status_filters[]=canceled`)., fulfillment_filters: str # Comma-separated fulfillment filters. Accepted values: `unfulfilled`, `partial`, `fulfilled`, `not applicable` (orders without shipping), or a shipment status of the latest fulfillment: `requested`, `in_transit`, `delivered`, `failed`, `pickup_available`, `in_preparation`., dateFilter: str(today/yesterday/last7days/last30days/last90days/quarterToDate/yearToDate/blackFridayToCyberMonday/customDate) # Filter by completion date, in the store timezone. With `customDate`, use `initialDate` and `finalDate`; `customDate` without both dates returns the last 30 days., initialDate: str(date) # Start date (inclusive) in the format YYYY-MM-DD. Only used with `dateFilter=customDate` and `finalDate`., finalDate: str(date) # End date (inclusive) in the format YYYY-MM-DD. Only used with `dateFilter=customDate` and `initialDate`., fields: str # Comma-separated list of fields to include in each Order. All fields except `cart_id` are returned when omitted. `gift_cards` returns `gift_cards_discount`, `taxes` returns `shipping_taxes` and `status` returns both `status` and `status_name`. Available fields: `id`, `source`, `cart_id`, `created_at`, `completed_at`, `currency`, `subtotal`, `tax`, `shipping_tax`, `shipping`, `shipping_required`, `total`, `discount`, `shipping_discount`, `gift_cards`, `fulfillment_status`, `shipping_method_id`, `shipping_service_id`, `shipping_method_name`, `payment_method_name`, `payment_method_type`, `payment_information`, `payment_notification_id`, `additional_information`, `duplicate_url`, `recovery_url`, `review_url`, `checkout_url`, `coupons`, `promotions`, `customer`, `shipping_branch`, `shipping_address`, `billing_address`, `pickup_address`, `products`, `additional_fields`, `taxes`, `status`, `tracking_url`, `tracking_company`, `tracking_number`, `shipping_option`, `same_day_delivery`, `shipment_status`, `shipment_status_enum`, `recovered_from`, `external_shipping_rate_id`, `external_shipping_rate_description`, `billing_information`., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of Orders\n@errors {400: Invalid `initialDate` or `finalDate`.}\n\n@endpoint POST /orders.json\n@desc Create a new Order.\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., order: map{status: str, source: str, coupons: str, shipping_method_id: int(int32), shipping_method_name: str, shipping_price: num(float), shipping_required: bool, allow_missing_products: bool, payment_method_id: int(int32), payment_method_name: str, payment_notification_id: str, additional_information: str, additional_fields: [map], customer!: map, products!: [map], billing_information: map}}\n@returns(200) {order: map{id: int(int32), source: map{created_from: str, created_from_app_code: str, source_name: str, medium: str, campaign: str, referral_url: str, referral_code: str, user_agent: str, first_page_visited: str, first_page_visited_at: str, referral_source: str}, created_at: str, completed_at: str, currency: str, subtotal: num(float), tax: num(float), shipping_tax: num(float), shipping: num(float), shipping_required: bool, total: num(float), discount: num(float), shipping_discount: num(float), gift_cards_discount: num(float), fulfillment_status: str, shipping_method_id: int(int32), shipping_service_id: int(int32), shipping_method_name: str, payment_method_name: str, payment_method_type: str, payment_information: str, payment_notification_id: str, additional_information: str, duplicate_url: str, recovery_url: str, review_url: str, checkout_url: str, coupons: str, promotions: [map], customer: map{id: int(int32), email: str, phone: str, phone_prefix: str, ip: str, fullname: str}, shipping_branch: map{id: int(int32), name: str}, shipping_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, latitude: num, longitude: num, municipality: str, neighbourhood: str}, billing_address: map{name: str, surname: str, taxid: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, neighbourhood: str}, pickup_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, pickup_place_name: str, taxid: str, neighbourhood: str}, products: [map], additional_fields: [map], shipping_taxes: [map], fees: [map], status: str, status_name: str, tracking_url: str, tracking_company: str, tracking_number: str, shipping_option: str?, same_day_delivery: bool, shipment_status: str, shipment_status_enum: str, recovered_from: int(int32)?, external_shipping_rate_id: str, external_shipping_rate_description: str, billing_information: map{business_activity: str, company_name: str, taxpayer_type: str}, cart_id: int(int32)}} # OK\n@errors {400: Invalid request: missing products, invalid product, address, shipping method, status or additional fields, out of stock, daily limit reached or checkout closed., 403: The store is on a free trial., 404: Customer not found.}\n\n@endgroup\n\n@group orders\n@endpoint GET /orders/count.json\n@desc Count all Orders.\n@returns(200) {count: int(int32)} # OK\n\n@endpoint GET /orders/status/{status}.json\n@desc Retrieve orders filtered by status.\n@required {status: str(abandoned/canceled/pending_payment/paid) # Status of the Order used as filter. Titleized values (e.g. `Pending Payment`) are also accepted.}\n@optional {fields: str # Comma-separated list of fields to include in each Order. All fields except `cart_id` are returned when omitted. `gift_cards` returns `gift_cards_discount`, `taxes` returns `shipping_taxes` and `status` returns both `status` and `status_name`. Available fields: `id`, `source`, `cart_id`, `created_at`, `completed_at`, `currency`, `subtotal`, `tax`, `shipping_tax`, `shipping`, `shipping_required`, `total`, `discount`, `shipping_discount`, `gift_cards`, `fulfillment_status`, `shipping_method_id`, `shipping_service_id`, `shipping_method_name`, `payment_method_name`, `payment_method_type`, `payment_information`, `payment_notification_id`, `additional_information`, `duplicate_url`, `recovery_url`, `review_url`, `checkout_url`, `coupons`, `promotions`, `customer`, `shipping_branch`, `shipping_address`, `billing_address`, `pickup_address`, `products`, `additional_fields`, `taxes`, `status`, `tracking_url`, `tracking_company`, `tracking_number`, `shipping_option`, `same_day_delivery`, `shipment_status`, `shipment_status_enum`, `recovered_from`, `external_shipping_rate_id`, `external_shipping_rate_description`, `billing_information`., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) OK\n@errors {400: Status invalid.}\n\n@endpoint GET /orders/{id}.json\n@desc Retrieve a single Order.\n@required {id: int(int32) # Id of the Order}\n@optional {fields: str # Comma-separated list of fields to include in each Order. All fields except `cart_id` are returned when omitted. `gift_cards` returns `gift_cards_discount`, `taxes` returns `shipping_taxes` and `status` returns both `status` and `status_name`. Available fields: `id`, `source`, `cart_id`, `created_at`, `completed_at`, `currency`, `subtotal`, `tax`, `shipping_tax`, `shipping`, `shipping_required`, `total`, `discount`, `shipping_discount`, `gift_cards`, `fulfillment_status`, `shipping_method_id`, `shipping_service_id`, `shipping_method_name`, `payment_method_name`, `payment_method_type`, `payment_information`, `payment_notification_id`, `additional_information`, `duplicate_url`, `recovery_url`, `review_url`, `checkout_url`, `coupons`, `promotions`, `customer`, `shipping_branch`, `shipping_address`, `billing_address`, `pickup_address`, `products`, `additional_fields`, `taxes`, `status`, `tracking_url`, `tracking_company`, `tracking_number`, `shipping_option`, `same_day_delivery`, `shipment_status`, `shipment_status_enum`, `recovered_from`, `external_shipping_rate_id`, `external_shipping_rate_description`, `billing_information`., locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language.}\n@returns(200) {order: map{id: int(int32), source: map{created_from: str, created_from_app_code: str, source_name: str, medium: str, campaign: str, referral_url: str, referral_code: str, user_agent: str, first_page_visited: str, first_page_visited_at: str, referral_source: str}, created_at: str, completed_at: str, currency: str, subtotal: num(float), tax: num(float), shipping_tax: num(float), shipping: num(float), shipping_required: bool, total: num(float), discount: num(float), shipping_discount: num(float), gift_cards_discount: num(float), fulfillment_status: str, shipping_method_id: int(int32), shipping_service_id: int(int32), shipping_method_name: str, payment_method_name: str, payment_method_type: str, payment_information: str, payment_notification_id: str, additional_information: str, duplicate_url: str, recovery_url: str, review_url: str, checkout_url: str, coupons: str, promotions: [map], customer: map{id: int(int32), email: str, phone: str, phone_prefix: str, ip: str, fullname: str}, shipping_branch: map{id: int(int32), name: str}, shipping_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, latitude: num, longitude: num, municipality: str, neighbourhood: str}, billing_address: map{name: str, surname: str, taxid: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, neighbourhood: str}, pickup_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, pickup_place_name: str, taxid: str, neighbourhood: str}, products: [map], additional_fields: [map], shipping_taxes: [map], fees: [map], status: str, status_name: str, tracking_url: str, tracking_company: str, tracking_number: str, shipping_option: str?, same_day_delivery: bool, shipment_status: str, shipment_status_enum: str, recovered_from: int(int32)?, external_shipping_rate_id: str, external_shipping_rate_description: str, billing_information: map{business_activity: str, company_name: str, taxpayer_type: str}, cart_id: int(int32)}} # OK\n@errors {404: Order Not Found.}\n\n@endpoint PUT /orders/{id}.json\n@desc Modify an existing Order.\n@required {id: int(int32) # Id of the Order}\n@optional {order: map{status: str, shipment_status: str, tracking_number: str, tracking_company: str, tracking_url: str, expected_arrival_from: str(date), expected_arrival_to: str(date), additional_information: str, additional_fields: [map], customer: map}}\n@returns(200) {order: map{id: int(int32), source: map{created_from: str, created_from_app_code: str, source_name: str, medium: str, campaign: str, referral_url: str, referral_code: str, user_agent: str, first_page_visited: str, first_page_visited_at: str, referral_source: str}, created_at: str, completed_at: str, currency: str, subtotal: num(float), tax: num(float), shipping_tax: num(float), shipping: num(float), shipping_required: bool, total: num(float), discount: num(float), shipping_discount: num(float), gift_cards_discount: num(float), fulfillment_status: str, shipping_method_id: int(int32), shipping_service_id: int(int32), shipping_method_name: str, payment_method_name: str, payment_method_type: str, payment_information: str, payment_notification_id: str, additional_information: str, duplicate_url: str, recovery_url: str, review_url: str, checkout_url: str, coupons: str, promotions: [map], customer: map{id: int(int32), email: str, phone: str, phone_prefix: str, ip: str, fullname: str}, shipping_branch: map{id: int(int32), name: str}, shipping_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, latitude: num, longitude: num, municipality: str, neighbourhood: str}, billing_address: map{name: str, surname: str, taxid: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, neighbourhood: str}, pickup_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, pickup_place_name: str, taxid: str, neighbourhood: str}, products: [map], additional_fields: [map], shipping_taxes: [map], fees: [map], status: str, status_name: str, tracking_url: str, tracking_company: str, tracking_number: str, shipping_option: str?, same_day_delivery: bool, shipment_status: str, shipment_status_enum: str, recovered_from: int(int32)?, external_shipping_rate_id: str, external_shipping_rate_description: str, billing_information: map{business_activity: str, company_name: str, taxpayer_type: str}, cart_id: int(int32)}} # OK\n@errors {400: Invalid request: no updatable field, invalid status, shipment status, dates or additional fields, or checkout closed., 403: The store is on a free trial, or missing `fulfillment` permission to change the shipment., 404: Order Not Found.}\n\n@endgroup\n\n@group appointments.json\n@endpoint GET /appointments.json\n@desc Retrieve all Appointments.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1., fields: str # Comma-separated appointment fields to include in each response., status: str(created/voided/canceled/pending/booked/completed) # Filter by appointment status., product_id: int(int32) # Filter by appointment product id., customer_id: int(int32) # Filter by customer id., start_date: str(date) # Inclusive lower boundary for the appointment start date., end_date: str(date) # Inclusive upper boundary for the appointment start date.}\n@returns(200) An array of appointments.\n@errors {400: Invalid date filter.}\n\n@endgroup\n\n@group appointments\n@endpoint GET /appointments/{id}.json\n@desc Retrieve an Appointment.\n@required {id: int(int32) # Id of the appointment.}\n@optional {fields: str # Comma-separated appointment fields to include in the response.}\n@returns(200) {appointment: map{id: int, status: str, status_name: str, name: str?, duration: int, store_timezone: str, timeslot: map{start_date: str(date), start_time: str, end_date: str(date), end_time: str, duration: int, timezone: str}, product_id: int, product_name: str, customer_id: int, customer_name: str, customer_email: str(email), order_product_id: int, order_id: int, order_number: int, created_at: str, updated_at: str}} # Appointment retrieved successfully.\n@errors {404: Appointment not found.}\n\n@endpoint PUT /appointments/{id}.json\n@desc Update an Appointment.\n@required {id: int(int32) # Id of the appointment.}\n@optional {fields: str # Comma-separated appointment fields to include in the response., appointment: map{status: str, start_time: str, end_time: str}}\n@returns(200) {appointment: map{id: int, status: str, status_name: str, name: str?, duration: int, store_timezone: str, timeslot: map{start_date: str(date), start_time: str, end_date: str(date), end_time: str, duration: int, timezone: str}, product_id: int, product_name: str, customer_id: int, customer_name: str, customer_email: str(email), order_product_id: int, order_id: int, order_number: int, created_at: str, updated_at: str}} # Appointment updated successfully.\n@errors {400: Unavailable timeslot or invalid status transition, or invalid request., 404: Appointment not found.}\n\n@endgroup\n\n@group orders\n@endpoint GET /orders/search.json\n@desc Retrieve an Orders List from a query.\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language., query: str # Text to search for: an Order id, a customer email, or words matched against customer names, addresses and tax ids. Queries shorter than 3 characters are ignored., status_filters: str # Order statuses to filter by. Send comma-separated values (`status_filters=paid,canceled`) or repeat the parameter as an array (`status_filters[]=paid&status_filters[]=canceled`)., fulfillment_filters: str # Comma-separated fulfillment filters. Accepted values: `unfulfilled`, `partial`, `fulfilled`, `not applicable` (orders without shipping), or a shipment status of the latest fulfillment: `requested`, `in_transit`, `delivered`, `failed`, `pickup_available`, `in_preparation`., dateFilter: str(today/yesterday/last7days/last30days/last90days/quarterToDate/yearToDate/blackFridayToCyberMonday/customDate) # Filter by completion date, in the store timezone. With `customDate`, use `initialDate` and `finalDate`; `customDate` without both dates returns the last 30 days., initialDate: str(date) # Start date (inclusive) in the format YYYY-MM-DD. Only used with `dateFilter=customDate` and `finalDate`., finalDate: str(date) # End date (inclusive) in the format YYYY-MM-DD. Only used with `dateFilter=customDate` and `initialDate`., fields: str # Comma-separated list of fields to include in each Order. All fields except `cart_id` are returned when omitted. `gift_cards` returns `gift_cards_discount`, `taxes` returns `shipping_taxes` and `status` returns both `status` and `status_name`. Available fields: `id`, `source`, `cart_id`, `created_at`, `completed_at`, `currency`, `subtotal`, `tax`, `shipping_tax`, `shipping`, `shipping_required`, `total`, `discount`, `shipping_discount`, `gift_cards`, `fulfillment_status`, `shipping_method_id`, `shipping_service_id`, `shipping_method_name`, `payment_method_name`, `payment_method_type`, `payment_information`, `payment_notification_id`, `additional_information`, `duplicate_url`, `recovery_url`, `review_url`, `checkout_url`, `coupons`, `promotions`, `customer`, `shipping_branch`, `shipping_address`, `billing_address`, `pickup_address`, `products`, `additional_fields`, `taxes`, `status`, `tracking_url`, `tracking_company`, `tracking_number`, `shipping_option`, `same_day_delivery`, `shipment_status`, `shipment_status_enum`, `recovered_from`, `external_shipping_rate_id`, `external_shipping_rate_description`, `billing_information`., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) {count: int, orders: [map]} # OK\n@errors {400: Invalid `initialDate` or `finalDate`., 429: Rate limit of 100 searches per hour exceeded.}\n\n@endpoint GET /orders/after/{id}.json\n@desc Retrieve orders filtered by Order Id.\n@required {id: int(int32) # Id of the Order}\n@optional {fields: str # Comma-separated list of fields to include in each Order. All fields except `cart_id` are returned when omitted. `gift_cards` returns `gift_cards_discount`, `taxes` returns `shipping_taxes` and `status` returns both `status` and `status_name`. Available fields: `id`, `source`, `cart_id`, `created_at`, `completed_at`, `currency`, `subtotal`, `tax`, `shipping_tax`, `shipping`, `shipping_required`, `total`, `discount`, `shipping_discount`, `gift_cards`, `fulfillment_status`, `shipping_method_id`, `shipping_service_id`, `shipping_method_name`, `payment_method_name`, `payment_method_type`, `payment_information`, `payment_notification_id`, `additional_information`, `duplicate_url`, `recovery_url`, `review_url`, `checkout_url`, `coupons`, `promotions`, `customer`, `shipping_branch`, `shipping_address`, `billing_address`, `pickup_address`, `products`, `additional_fields`, `taxes`, `status`, `tracking_url`, `tracking_company`, `tracking_number`, `shipping_option`, `same_day_delivery`, `shipment_status`, `shipment_status_enum`, `recovered_from`, `external_shipping_rate_id`, `external_shipping_rate_description`, `billing_information`., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) OK\n\n@endpoint GET /orders/{id}/history.json\n@desc Retrieve all Order History.\n@required {id: int(int32) # Id of the Order}\n@returns(200) An array with Order History\n@errors {404: Order Not Found.}\n\n@endpoint POST /orders/{id}/history.json\n@desc Create a new Order History Entry.\n@required {id: int(int32) # Id of the Order}\n@optional {order_history: map{message: str, log: map}}\n@returns(200) {order_history: map{id: int(int32), message: str, created_at: str}} # OK\n@errors {404: Order Not Found.}\n\n@endpoint GET /orders/{id}/documents.json\n@desc Retrieve all Documents from an Order.\n@required {id: int(int32) # Id of the Order}\n@returns(200) An array with Documents\n@errors {404: Order Not Found.}\n\n@endpoint POST /orders/{id}/documents.json\n@desc Create a new Order Document Entry.\n@required {id: int(int32) # Id of the Order, document: map{document_type: int, external_id: str, public_id: str, url: str, app_code: str}}\n@returns(200) {order_document: map{document_type: str, external_id: str, public_id: str, url: str, order_id: int(int32)}} # OK\n@errors {400: A required field is missing., 404: Order or app not found, Document already exists, or the Document could not be saved.}\n\n@endpoint PUT /orders/{id}/documents/{public_id}.json\n@desc Update a Document from an Order.\n@required {id: int(int32) # Id of the Order, public_id: str # Public Id of the Document, document: map{document_type: int, external_id: str, public_id: str, url: str, app_code: str}}\n@returns(200) {order_document: map{document_type: str, external_id: str, public_id: str, url: str, order_id: int(int32)}} # OK\n@errors {404: Order, Document or app not found, or the Document could not be saved.}\n\n@endpoint DELETE /orders/{id}/documents/{public_id}.json\n@desc Delete a Document from an Order.\n@required {id: int(int32) # Id of the Order, public_id: str # Public Id of the Document}\n@returns(200) {message: str} # OK\n@errors {400: Could not delete Document., 404: Order or Document Not Found.}\n\n@endgroup\n\n@group fulfillments\n@endpoint GET /fulfillments/count.json\n@desc Count all Fulfillments.\n@returns(200) {count: int(int32)} # OK\n\n@endpoint POST /fulfillments/rates.json\n@desc Rates for fulfillment.\n@optional {rates: map{order_id: int(int32), location_id: int(int32), origin_address: map, shipping_address: map, receiver_email: str, packages_dimensions: [map]}}\n@returns(200) OK\n@errors {404: Order Not Found.}\n\n@endpoint POST /fulfillments/rates/settings.json\n@desc Additional fulfillment settings by carrier.\n@optional {rates: map{order_id: int(int32), location_id: int(int32), origin_address: map, shipping_address: map, receiver_email: str, packages_dimensions: [map]}}\n@returns(200) OK\n@errors {404: Order Not Found.}\n\n@endgroup\n\n@group fulfillments.json\n@endpoint GET /fulfillments.json\n@desc Retrieve all Fulfillments.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of Fulfillments\n\n@endpoint POST /fulfillments.json\n@desc Create a new Fulfillment.\n@optional {fulfillment: map{order_id: str, type!: str, shipping_address: map, receiver_email: str, packages_dimensions: [map], location_id!: str, phone_number: str, phone_prefix: str, tracking_number: str, tracking_company: str, tracking_url: str, external_id: str, service_type: str, message: str, observations: str, expected_arrival_from: str, expected_arrival_to: str, send_email: bool}}\n@returns(200) {order_fulfillment: map{id: int(int32), created_at: str, updated_at: str, tracking_number: str?, tracking_company: str?, type: str, shipment_status: str?, expected_arrival_from: str?, expected_arrival_to: str?, order_id: int(int32)?, order: any, fulfillment_address: any, label_url: str}} # OK\n@errors {400: Invalid fulfillment data, Order not found, or the fulfillment could not be created.}\n\n@endgroup\n\n@group fulfillments\n@endpoint GET /fulfillments/{id}/label.json\n@desc Retrieve a presigned URL for the Fulfillment label\n@required {id: int(int32) # ID of the Fulfillment}\n@returns(200) {url: str, expires_at: str(date-time)} # Label URL retrieved successfully\n@errors {400: Invalid Label - The label could not be generated or found, 404: Fulfillment Not Found, 500: The label could not be retrieved.}\n\n@endpoint GET /fulfillments/{id}.json\n@desc Retrieve a single Fulfillment.\n@required {id: int(int32) # Id of the Fulfillment}\n@returns(200) {order_fulfillment: map{id: int(int32), created_at: str, updated_at: str, tracking_number: str?, tracking_company: str?, type: str, shipment_status: str?, expected_arrival_from: str?, expected_arrival_to: str?, order_id: int(int32)?, order: any, fulfillment_address: any, label_url: str}} # OK\n@errors {404: Fulfillment Not Found.}\n\n@endpoint PUT /fulfillments/{id}.json\n@desc Modify an existing Fulfillment.\n@required {id: int(int32) # Id of the Fulfillment}\n@optional {fulfillment: map{shipment_status: str, type: str, tracking_number: str, tracking_company: str, tracking_url: str, external_id: str, service_type: str, message: str, observations: str, expected_arrival_from: str(date), expected_arrival_to: str(date)}}\n@returns(200) {order_fulfillment: map{id: int(int32), created_at: str, updated_at: str, tracking_number: str?, tracking_company: str?, type: str, shipment_status: str?, expected_arrival_from: str?, expected_arrival_to: str?, order_id: int(int32)?, order: any, fulfillment_address: any, label_url: str}} # OK\n@errors {400: Tracking company selected is not available., 404: Fulfillment Not Found, or invalid `shipment_status` or `type`.}\n\n@endgroup\n\n@group order\n@endpoint GET /order/{id}/fulfillments.json\n@desc Retrieve the Fulfillments associated with the Order.\n@required {id: int(int32) # Id of the Order}\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) OK\n@errors {404: Order Not Found.}\n\n@endgroup\n\n@group pages.json\n@endpoint GET /pages.json\n@desc Retrieve all Pages.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of Pages\n\n@endpoint POST /pages.json\n@desc Create a new Page.\n@optional {page: map{title: str, body: str, status: str, page_title: str, meta_description: str, categories: [int], template: str, permalink: str}}\n@returns(200) {page: map{id: int, title: str, body: str, status: str, legal: bool, page_title: str, meta_description: str, categories: [map], template: map{name: str}, permalink: str, image: map?{id: int, url: str}}} # OK\n@errors {400: Invalid JSON body, Page data missing, or invalid template., 404: The Page could not be created (e.g. missing title).}\n\n@endgroup\n\n@group pages\n@endpoint GET /pages/count.json\n@desc Count all Pages.\n@returns(200) {count: int(int32)} # Total number of pages\n\n@endpoint GET /pages/{id}.json\n@desc Retrieve a single Page.\n@required {id: int(int32) # Id of the Page}\n@returns(200) {page: map{id: int, title: str, body: str, status: str, legal: bool, page_title: str, meta_description: str, categories: [map], template: map{name: str}, permalink: str, image: map?{id: int, url: str}}} # OK\n@errors {404: Page Not Found.}\n\n@endpoint PUT /pages/{id}.json\n@desc Update a Page.\n@required {id: int(int32) # Id of the Page}\n@optional {page: map{title: str, body: str, status: str, page_title: str, meta_description: str, categories: [int], template: str, permalink: str}}\n@returns(200) {page: map{id: int, title: str, body: str, status: str, legal: bool, page_title: str, meta_description: str, categories: [map], template: map{name: str}, permalink: str, image: map?{id: int, url: str}}} # OK\n@errors {400: Invalid JSON body, Page data missing, or invalid template., 404: Page not found, or the Page could not be saved.}\n\n@endpoint DELETE /pages/{id}.json\n@desc Delete an existing Page.\n@required {id: int(int32) # Id of the Page}\n@returns(200) {message: str} # OK\n@errors {404: Page Not Found.}\n\n@endpoint GET /pages/{id}/images.json\n@desc Retrieve all Page Images.\n@required {id: int(int32) # Id of the Page}\n@returns(200) OK\n@errors {404: Page Not Found.}\n\n@endpoint POST /pages/{id}/images.json\n@desc Create a new Page Image.\n@required {id: int(int32) # Id of the Page}\n@optional {image: map{url: str}}\n@returns(200) {image: map{id: int(int32), url: str}} # OK\n@errors {403: Storage limit reached., 404: Page not found, the Page already has an image, or `url` is missing., 422: The image could not be downloaded or is not a valid image.}\n\n@endpoint GET /pages/{id}/images/count.json\n@desc Count all Page Images.\n@required {id: int(int32) # Id of the Page}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Page Not Found.}\n\n@endpoint GET /pages/{id}/images/{image_id}.json\n@desc Retrieve a single Page Image.\n@required {id: int(int32) # Id of the Page, image_id: int(int32) # Id of the Page Image}\n@returns(200) {image: map{id: int(int32), url: str}} # OK\n@errors {404: Page or Image not found.}\n\n@endpoint PUT /pages/{id}/images/{image_id}.json\n@desc Update a Page Image url.\n@required {id: int(int32) # Id of the Page, image_id: int(int32) # Id of the Page Image}\n@optional {image: map{url: str}}\n@returns(200) {image: map{id: int(int32), url: str}} # OK\n@errors {404: Page, Image or `url` not found., 422: The image could not be downloaded or is not a valid image.}\n\n@endpoint DELETE /pages/{id}/images/{image_id}.json\n@desc Delete a Page Image.\n@required {id: int(int32) # Id of the Page, image_id: int(int32) # Id of the Page Image}\n@returns(200) {message: str} # OK\n@errors {404: Page or Image not found.}\n\n@endgroup\n\n@group customers.json\n@endpoint GET /customers.json\n@desc Retrieve all Customers.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of Customers\n\n@endpoint POST /customers.json\n@desc Create a new Customer.\n@optional {customer: map{email: str, phone: str, phone_prefix: str, password: str, status: str, accepts_marketing: bool, registered: bool, locale: str, shipping_address: map, billing_address: map, customer_category: [int]}}\n@returns(200) {customer: map{id: int(int32), email: str, phone: str?, phone_prefix: str?, fullname: str, status: str, accepts_marketing: bool, accepted_marketing_at: str(date-time)?, cancelled_marketing_at: str(date-time)?, unconfirmed_email: str?, shipping_addresses: [map], billing_addresses: [map], customer_categories: [map], customer_additional_fields: [map]}} # OK\n@errors {400: Daily customer creation limit reached, invalid phone number or missing `customer` body., 404: Email already registered, Country or Region not found, or the Customer could not be saved.}\n\n@endgroup\n\n@group customers\n@endpoint GET /customers/count.json\n@desc Count all Customers.\n@returns(200) {count: int(int32)} # OK\n\n@endpoint GET /customers/email/{email}.json\n@desc Retrieve a single Customer by email.\n@required {email: str # Email of the Customer}\n@returns(200) {customer: map{id: int(int32), email: str, phone: str?, phone_prefix: str?, fullname: str, status: str, accepts_marketing: bool, accepted_marketing_at: str(date-time)?, cancelled_marketing_at: str(date-time)?, unconfirmed_email: str?, shipping_addresses: [map], billing_addresses: [map], customer_categories: [map], customer_additional_fields: [map]}} # OK\n@errors {404: Customer Not Found.}\n\n@endpoint GET /customers/{id}/orders.json\n@desc Retrieve all Orders of a single Customer.\n@required {id: int # ID of the Customer}\n@optional {fields: str # Comma separated list of Order fields to include in the response (e.g. `id,status,total`). All fields are returned when omitted., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of Orders\n@errors {404: Customer Not Found.}\n\n@endpoint GET /customers/{id}/orders/status/{status}.json\n@desc Retrieve all Orders of a single Customer by status.\n@required {id: int # ID of the Customer, status: str(Abandoned/Canceled/Pending Payment/Paid) # Status of the Order used as filter (case insensitive, spaces or underscores).}\n@optional {fields: str # Comma separated list of Order fields to include in the response (e.g. `id,status,total`). All fields are returned when omitted., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of Orders\n@errors {400: Status invalid., 404: Customer Not Found.}\n\n@endpoint GET /customers/{id}.json\n@desc Retrieve a single Customer by id.\n@required {id: int(int32) # Id of the Customer}\n@returns(200) {customer: map{id: int(int32), email: str, phone: str?, phone_prefix: str?, fullname: str, status: str, accepts_marketing: bool, accepted_marketing_at: str(date-time)?, cancelled_marketing_at: str(date-time)?, unconfirmed_email: str?, shipping_addresses: [map], billing_addresses: [map], customer_categories: [map], customer_additional_fields: [map]}} # OK\n@errors {404: Customer Not Found.}\n\n@endpoint PUT /customers/{id}.json\n@desc Update a Customer.\n@required {id: int(int32) # Id of the Customer}\n@optional {customer: map{email: str, phone: str, phone_prefix: str, password: str, status: str, accepts_marketing: bool, registered: bool, locale: str, shipping_address: map, billing_address: map, customer_category: [int]}}\n@returns(200) {customer: map{id: int(int32), email: str, phone: str?, phone_prefix: str?, fullname: str, status: str, accepts_marketing: bool, accepted_marketing_at: str(date-time)?, cancelled_marketing_at: str(date-time)?, unconfirmed_email: str?, shipping_addresses: [map], billing_addresses: [map], customer_categories: [map], customer_additional_fields: [map]}} # OK\n@errors {400: Missing `customer` body or invalid JSON., 404: Customer not found, Country or Region not found, or the Customer could not be saved.}\n\n@endpoint DELETE /customers/{id}.json\n@desc Delete an existing Customer.\n@required {id: int(int32) # Id of the Customer}\n@returns(200) {message: str} # OK\n@errors {404: Customer not found or could not be deleted.}\n\n@endpoint GET /customers/search.json\n@desc Retrieve a Customer List from a query.\n@required {query: str # Text to query for the Customer. If empty, returns all Customers.}\n@optional {order: str(asc/desc)=asc # Sort Customers by id: 'asc' for ascending order or 'desc' for descending order., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) {count: int(int32), customers: [map]} # Total number of matches and the requested page of Customers\n@errors {404: Query parameter missing, or order is not 'asc' or 'desc'.}\n\n@endgroup\n\n@group customer_categories.json\n@endpoint GET /customer_categories.json\n@desc Retrieve all Customer Categories.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of Customer Categories\n\n@endpoint POST /customer_categories.json\n@desc Create a new CustomerCategory.\n@optional {customer_category: map{name: str}}\n@returns(200) {customer_category: map{id: int(int32), name: str, code: str}} # OK\n@errors {404: CustomerCategory could not be saved.}\n\n@endgroup\n\n@group customer_categories\n@endpoint GET /customer_categories/{id}.json\n@desc Retrieve a single CustomerCategory.\n@required {id: int(int32) # Id of the CustomerCategory}\n@returns(200) {customer_category: map{id: int(int32), name: str, code: str}} # OK\n@errors {404: CustomerCategory Not Found.}\n\n@endpoint PUT /customer_categories/{id}.json\n@desc Update a CustomerCategory.\n@required {id: int(int32) # Id of the CustomerCategory}\n@optional {customer_category: map{name: str}}\n@returns(200) {customer_category: map{id: int(int32), name: str, code: str}} # OK\n@errors {404: CustomerCategory not found or could not be saved.}\n\n@endpoint DELETE /customer_categories/{id}.json\n@desc Delete an existing CustomerCategory.\n@required {id: int(int32) # Id of the CustomerCategory}\n@returns(200) {message: str} # OK\n@errors {404: CustomerCategory Not Found.}\n\n@endpoint GET /customer_categories/{id}/customers.json\n@desc Retrieves the customers in a CustomerCategory.\n@required {id: int(int32) # Id of the CustomerCategory}\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) OK\n@errors {404: CustomerCategory Not Found.}\n\n@endpoint POST /customer_categories/{id}/customers.json\n@desc Adds Customers to a CustomerCategory.\n@required {id: int(int32) # Id of the CustomerCategory}\n@optional {customers: [map{id: int(int32), email: str}]}\n@returns(200) {message: str} # OK\n@errors {404: CustomerCategory Not Found.}\n\n@endpoint DELETE /customer_categories/{id}/customers/{customer_id}.json\n@desc Delete Customer from an existing CustomerCategory.\n@required {id: int(int32) # Id of the CustomerCategory, customer_id: int(int32) # Id of the Customer}\n@returns(200) {message: str} # OK\n@errors {404: CustomerCategory or Customer not found, or the Customer is not in the CustomerCategory.}\n\n@endgroup\n\n@group customers\n@endpoint GET /customers/{id}/fields.json\n@desc Retrieve the Customer Additional Fields of a Customer.\n@required {id: int(int32) # Id of the Customer}\n@returns(200) OK\n@errors {404: Customer not found, or the Customer doesn't have additional fields.}\n\n@endpoint POST /customers/{id}/fields.json\n@desc Adds Customer Additional Fields to a Customer.\n@required {id: int(int32) # Id of the Customer}\n@optional {customer_additional_field: map{value!: str, checkout_custom_field_id!: int(int32)}}\n@returns(200) {customer_additional_field: map{id: int(int32), label: str, value: str, area: str, customer_id: int(int32), checkout_custom_field_id: int(int32)}} # OK\n@errors {400: Missing `customer_additional_field` body or invalid JSON., 404: Customer or Checkout Custom Field not found, value missing or not a valid option, value already set for this Customer, or it could not be saved.}\n\n@endpoint GET /customers/{id}/fields/{field_id}.json\n@desc Retrieve a single Customer Additional Field.\n@required {id: int(int32) # Id of the Customer, field_id: int(int32) # Id of the Customer Additional Field}\n@returns(200) {customer_additional_field: map{id: int(int32), label: str, value: str, area: str, customer_id: int(int32), checkout_custom_field_id: int(int32)}} # OK\n@errors {404: Customer or Customer Additional Field not found.}\n\n@endpoint PUT /customers/{id}/fields/{field_id}.json\n@desc Update a Customer Additional Field.\n@required {id: int(int32) # Id of the Customer, field_id: int(int32) # Id of the Customer Additional Field}\n@optional {customer_additional_field: map{value!: str}}\n@returns(200) {customer_additional_field: map{id: int(int32), label: str, value: str, area: str, customer_id: int(int32), checkout_custom_field_id: int(int32)}} # OK\n@errors {400: Value missing, missing `customer_additional_field` body or invalid JSON., 404: Customer or Customer Additional Field not found, value not a valid option, or it could not be saved.}\n\n@endpoint DELETE /customers/{id}/fields/{field_id}.json\n@desc Delete a Customer Additional Field.\n@required {id: int(int32) # Id of the Customer, field_id: int(int32) # Id of the Customer Additional Field}\n@returns(200) {message: str} # OK\n@errors {404: Customer not found or the Customer Additional Field could not be deleted.}\n\n@endgroup\n\n@group promotions.json\n@endpoint GET /promotions.json\n@desc Retrieve all Promotions.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of Promotions\n@errors {403: Promotion API endpoints are restricted to Pro plan and above.}\n\n@endpoint POST /promotions.json\n@desc Create a new Promotion.\n@optional {promotion: map{name!: str, enabled: bool, discount_target!: str, buys_at_least: str, condition_price: num(float), condition_qty: int(int32), quantity_x: int(int32), type: str, discount_amount_fix: num(float), discount_amount_percent: num(float), lasts: str, begins_at: str(date), expires_at: str(date), max_times_used: int(int32), cumulative: bool, customers: str, categories: [map], categories_x: [map], customer_categories: [map], products: [map], products_x: [map], coupons: [map], countries: [str], regions: [str], municipalities: [str]}}\n@returns(200) {promotion: map{id: int(int32), name: str, status: str, enabled: bool, discount_target: str, type: str, condition_price: num(float), condition_qty: int(int32), quantity_x: int(int32), discount_amount_fix: num(float), discount_amount_percent: num(float), begins_at: str(date-time)?, expires_at: str(date-time)?, times_used: int(int32), max_times_used: int(int32), cumulative: bool, customers: str, code: str?, coupons: [map], categories: [map], categories_x: [map], customer_categories: [map], products: [map], products_x: [map], countries: [str], regions: [str], municipalities: [str]}} # OK\n@errors {400: Invalid parameters, missing `promotion` body or the Promotion could not be saved., 403: Promotion API endpoints are restricted to Pro plan and above.}\n\n@endgroup\n\n@group promotions\n@endpoint GET /promotions/{id}.json\n@desc Retrieve a single Promotion.\n@required {id: int(int32) # Id of the Promotion}\n@returns(200) {promotion: map{id: int(int32), name: str, status: str, enabled: bool, discount_target: str, type: str, condition_price: num(float), condition_qty: int(int32), quantity_x: int(int32), discount_amount_fix: num(float), discount_amount_percent: num(float), begins_at: str(date-time)?, expires_at: str(date-time)?, times_used: int(int32), max_times_used: int(int32), cumulative: bool, customers: str, code: str?, coupons: [map], categories: [map], categories_x: [map], customer_categories: [map], products: [map], products_x: [map], countries: [str], regions: [str], municipalities: [str]}} # OK\n@errors {403: Promotion API endpoints are restricted to Pro plan and above., 404: Promotion Not Found.}\n\n@endpoint PUT /promotions/{id}.json\n@desc Update a Promotion.\n@required {id: int(int32) # Id of the Promotion}\n@optional {promotion: map{name!: str, enabled: bool, discount_target!: str, buys_at_least: str, condition_price: num(float), condition_qty: int(int32), quantity_x: int(int32), type: str, discount_amount_fix: num(float), discount_amount_percent: num(float), lasts: str, begins_at: str(date), expires_at: str(date), max_times_used: int(int32), cumulative: bool, customers: str, categories: [map], categories_x: [map], customer_categories: [map], products: [map], products_x: [map], coupons: [map], countries: [str], regions: [str], municipalities: [str]}}\n@returns(200) {promotion: map{id: int(int32), name: str, status: str, enabled: bool, discount_target: str, type: str, condition_price: num(float), condition_qty: int(int32), quantity_x: int(int32), discount_amount_fix: num(float), discount_amount_percent: num(float), begins_at: str(date-time)?, expires_at: str(date-time)?, times_used: int(int32), max_times_used: int(int32), cumulative: bool, customers: str, code: str?, coupons: [map], categories: [map], categories_x: [map], customer_categories: [map], products: [map], products_x: [map], countries: [str], regions: [str], municipalities: [str]}} # OK\n@errors {400: Invalid parameters, missing `promotion` body or the Promotion could not be saved., 403: Promotion API endpoints are restricted to Pro plan and above., 404: Promotion Not Found.}\n\n@endpoint DELETE /promotions/{id}.json\n@desc Delete an existing Promotion.\n@required {id: int(int32) # Id of the Promotion}\n@returns(200) {message: str} # OK\n@errors {403: Promotion API endpoints are restricted to Pro plan and above., 404: Promotion Not Found.}\n\n@endgroup\n\n@group payment_methods.json\n@endpoint GET /payment_methods.json\n@desc Retrieve all Store's Payment Methods.\n@returns(200) An array of Payment Methods\n\n@endpoint POST /payment_methods.json\n@desc Creates an External Payment Method.\n@optional {payment_method: map{name: str, description: str, payment_method_url: str, key: str, secret: str, show_review: bool, use_new_version: bool}}\n@returns(200) {payment_method: map{id: int(int32), type: str, name: str}} # OK\n@errors {400: Missing or invalid `payment_method_url`, or the Payment Method could not be created.}\n\n@endgroup\n\n@group payment_methods\n@endpoint GET /payment_methods/{id}.json\n@desc Retrieve a single Payment Method.\n@required {id: int(int32) # Id of the Payment Method}\n@returns(200) {payment_method: map{id: int(int32), type: str, name: str}} # OK\n@errors {404: PaymentMethod Not Found.}\n\n@endpoint PUT /payment_methods/{id}.json\n@desc Update an External Payment Method.\n@required {id: int(int32) # Id of the Payment Method}\n@optional {payment_method: map{name: str, description: str, payment_method_url: str, key: str, secret: str, show_review: bool, use_new_version: bool}}\n@returns(200) {payment_method: map{id: int(int32), type: str, name: str}} # OK\n@errors {400: Invalid `payment_method_url`., 404: PaymentMethod Not Found.}\n\n@endgroup\n\n@group shipping_methods.json\n@endpoint GET /shipping_methods.json\n@desc Retrieve all Store's Shipping Methods.\n@optional {enabled: bool # Only return enabled (true) or disabled (false) Shipping Methods}\n@returns(200) An array of Shipping Methods\n@errors {400: Enabled can only be true or false.}\n\n@endpoint POST /shipping_methods.json\n@desc Creates a Shipping Method.\n@optional {shipping_method: any}\n@returns(200) {shipping_method: map{id: int(int32), type: str, name: str, enabled: bool, free_shipping: bool, free_shipping_minimum_purchase: num(float)?, fee: map?, callback_url: str, fetch_services_url: str, token: str, state: str, city: str, postal: str, services: [map], tables: [map]}} # OK\n@errors {400: Invalid shipping method type, missing required fields, invalid URL, or the Shipping Method could not be saved., 422: Invalid shipping table data.}\n\n@endgroup\n\n@group shipping_methods\n@endpoint GET /shipping_methods/{id}.json\n@desc Retrieve a single Shipping Method.\n@required {id: int(int32) # Id of the Shipping Method}\n@returns(200) {shipping_method: map{id: int(int32), type: str, name: str, enabled: bool, free_shipping: bool, free_shipping_minimum_purchase: num(float)?, fee: map?, callback_url: str, fetch_services_url: str, token: str, state: str, city: str, postal: str, services: [map], tables: [map]}} # OK\n@errors {404: ShippingMethod Not Found.}\n\n@endpoint PUT /shipping_methods/{id}.json\n@desc Update a Shipping Method.\n@required {id: int(int32) # Id of the Shipping Method}\n@optional {shipping_method: any}\n@returns(200) {shipping_method: map{id: int(int32), type: str, name: str, enabled: bool, free_shipping: bool, free_shipping_minimum_purchase: num(float)?, fee: map?, callback_url: str, fetch_services_url: str, token: str, state: str, city: str, postal: str, services: [map], tables: [map]}} # OK\n@errors {400: Shipping Method type is not editable, missing required fields, invalid URL, or the Shipping Method could not be saved., 404: Shipping Method Not Found., 422: Invalid shipping table data.}\n\n@endpoint DELETE /shipping_methods/{id}.json\n@desc Delete an existing Shipping Method.\n@required {id: int(int32) # Id of the Shipping Method}\n@returns(200) {message: str} # OK\n@errors {400: Shipping Method not destroyed., 404: Shipping Method Not Found.}\n\n@endgroup\n\n@group locations.json\n@endpoint GET /locations.json\n@desc Retrieve all Store's Locations.\n@returns(200) An array of Locations, main location first\n\n@endpoint POST /locations.json\n@desc Create a Location.\n@required {name: str # Name of the location, email: str # Email for the location, main: bool # Is the main location, pickup_point: bool # Is a pickup point, address: str # Street address of the Location, city: str # City of the Location, country: str # Country code of the Location (ISO 3166-1 alpha-2)}\n@optional {is_stock_origin: bool # Is a stock origin, complement: str # Address complement, postal: str # Postal code of the Location, region: str # Region code of the Location, municipality: str # Municipality code of the Location, latitude: num(float) # Latitude of the Location, longitude: num(float) # Longitude of the Location}\n@returns(200) {location: map{id: int(int32), name: str, email: str, active: bool, main: bool, pickup_point: bool, is_stock_origin: bool, location_address: map{id: int(int32), name: str, surname: str, address: str, street_number: str, complement: str, city: str, postal: str, country: str, region: str, type: str, taxid: str, taxid_type: str, default: bool, region_format: str, municipality: str, latitude: num(float), longitude: num(float)}}} # OK\n@errors {400: Invalid data., 422: Missing required attributes.}\n\n@endgroup\n\n@group locations\n@endpoint GET /locations/{id}.json\n@desc Retrieve a single Location.\n@required {id: int(int32) # Id of the location}\n@returns(200) {location: map{id: int(int32), name: str, email: str, active: bool, main: bool, pickup_point: bool, is_stock_origin: bool, location_address: map{id: int(int32), name: str, surname: str, address: str, street_number: str, complement: str, city: str, postal: str, country: str, region: str, type: str, taxid: str, taxid_type: str, default: bool, region_format: str, municipality: str, latitude: num(float), longitude: num(float)}}} # OK\n@errors {404: Location not found.}\n\n@endpoint PUT /locations/{id}.json\n@desc Update a Location.\n@required {id: int(int32) # Id of the location, name: str # Name of the location, email: str # Email for the location, address: str # Street address of the Location, city: str # City of the Location, country: str # Country code of the Location (ISO 3166-1 alpha-2)}\n@optional {description: str # Description of the location, instructions: str # Pickup instructions, pickup_point: bool # Is a pickup point, is_stock_origin: bool # Is a stock origin. Kept as is when omitted., complement: str # Address complement, postal: str # Postal code of the Location, region: str # Region code of the Location, municipality: str # Municipality code of the Location, latitude: num(float) # Latitude of the Location, longitude: num(float) # Longitude of the Location}\n@returns(200) {location: map{id: int(int32), name: str, email: str, active: bool, main: bool, pickup_point: bool, is_stock_origin: bool, location_address: map{id: int(int32), name: str, surname: str, address: str, street_number: str, complement: str, city: str, postal: str, country: str, region: str, type: str, taxid: str, taxid_type: str, default: bool, region_format: str, municipality: str, latitude: num(float), longitude: num(float)}}} # OK\n@errors {400: Invalid data., 404: Location not found., 422: Location could not be saved.}\n\n@endpoint DELETE /locations/{id}.json\n@desc Delete a Location.\n@required {id: int(int32) # Id of the location}\n@returns(200) {message: str} # OK\n@errors {404: Location not found, or it is the default Location, the only stock origin, or used by a Shipping Method.}\n\n@endgroup\n\n@group custom_fields.json\n@endpoint GET /custom_fields.json\n@desc Retrieve all Store's Custom Fields.\n@returns(200) {custom_fields: [map]} # The Custom Fields of the store\n\n@endpoint POST /custom_fields.json\n@desc Create a new Custom Field.\n@optional {custom_field: map{label!: str, type!: str, values: [str], product_visibility: bool}}\n@returns(200) {custom_field: map{id: int(int32), label: str, type: str, values: [str], product_visibility: bool}} # OK\n@errors {404: Malformed Custom Field JSON (missing `label`, or invalid `type`) or the Custom Field could not be saved.}\n\n@endgroup\n\n@group custom_fields\n@endpoint GET /custom_fields/{id}.json\n@desc Retrieve a single CustomField.\n@required {id: int(int32) # Id of the CustomField}\n@returns(200) {custom_field: map{id: int(int32), label: str, type: str, values: [str], product_visibility: bool}} # OK\n@errors {404: CustomField Not Found.}\n\n@endpoint PUT /custom_fields/{id}.json\n@desc Update a CustomField.\n@required {id: int(int32) # Id of the CustomField}\n@optional {custom_field: map{label!: str, type!: str, values: [str], product_visibility: bool}}\n@returns(200) {custom_field: map{id: int(int32), label: str, type: str, values: [str], product_visibility: bool}} # OK\n@errors {404: CustomField Not Found.}\n\n@endpoint DELETE /custom_fields/{id}.json\n@desc Delete an existing CustomField.\n@required {id: int(int32) # Id of the CustomField}\n@returns(200) {message: str} # OK\n@errors {404: Custom Field not found or could not be deleted.}\n\n@endpoint GET /custom_fields/{id}/select_options.json\n@desc Retrieve all Select Options of a Custom Field.\n@required {id: int(int32) # Id of the CustomField}\n@returns(200) {custom_field_select_options: [map]} # The Select Options of the Custom Field\n@errors {404: Custom Field not found, Custom Field is not a selection type.}\n\n@endpoint POST /custom_fields/{id}/select_options.json\n@desc Create a new Custom Field Select Option.\n@required {id: int(int32) # Id of the CustomField}\n@optional {custom_field_select_option: map{value: str}}\n@returns(200) {custom_field_select_option: map{id: int(int32), value: str}} # OK\n@errors {404: Custom Field not found, Custom Field is not a selection type, or the Select Option could not be saved.}\n\n@endpoint GET /custom_fields/{id}/select_options/{custom_field_select_option_id}.json\n@desc Retrieve a single SelectOption from a CustomField.\n@required {id: int(int32) # Id of the CustomField, custom_field_select_option_id: int(int32) # Id of the CustomFieldSelectOption}\n@returns(200) {custom_field_select_option: map{id: int(int32), value: str}} # OK\n@errors {404: Custom Field not found, Custom Field is not a selection type, or Select Option not found.}\n\n@endpoint PUT /custom_fields/{id}/select_options/{custom_field_select_option_id}.json\n@desc Update a SelectOption from a CustomField.\n@required {id: int(int32) # Id of the CustomField, custom_field_select_option_id: int(int32) # Id of the CustomFieldSelectOption}\n@optional {custom_field_select_option: map{value: str}}\n@returns(200) {custom_field_select_option: map{id: int(int32), value: str}} # OK\n@errors {404: Custom Field not found, Custom Field is not a selection type, Select Option not found, or it could not be saved.}\n\n@endpoint DELETE /custom_fields/{id}/select_options/{custom_field_select_option_id}.json\n@desc Delete a Select Option from a Custom Field.\n@required {id: int(int32) # Id of the CustomField, custom_field_select_option_id: int(int32) # Id of the CustomFieldSelectOption}\n@returns(200) {message: str} # OK\n@errors {404: Custom Field not found, Custom Field is not a selection type, Select Option not found, or it could not be deleted.}\n\n@endgroup\n\n@group checkout_custom_fields.json\n@endpoint GET /checkout_custom_fields.json\n@desc Retrieve all Checkout Custom Fields.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of Checkout Custom Fields\n\n@endpoint POST /checkout_custom_fields.json\n@desc Create a new CheckoutCustomField.\n@optional {checkout_custom_field: map{label: str, type: str, area: str, required: bool, position: int(int32), deletable: bool, is_date_restricted: bool, custom_field_select_options: [str]}}\n@returns(200) {checkout_custom_field: map{id: int(int32), label: str, type: str, area: str, required: bool, position: int(int32), deletable: bool, app_id: int(int32)?, checkout_custom_field_select_options: [map]}} # OK\n@errors {404: Invalid type, or the CheckoutCustomField could not be saved.}\n\n@endgroup\n\n@group checkout_custom_fields\n@endpoint GET /checkout_custom_fields/{id}.json\n@desc Retrieve a single CheckoutCustomField.\n@required {id: int(int32) # Id of the CheckoutCustomField}\n@returns(200) {checkout_custom_field: map{id: int(int32), label: str, type: str, area: str, required: bool, position: int(int32), deletable: bool, app_id: int(int32)?, checkout_custom_field_select_options: [map]}} # OK\n@errors {404: CheckoutCustomField Not Found.}\n\n@endpoint PUT /checkout_custom_fields/{id}.json\n@desc Update a CheckoutCustomField.\n@required {id: int(int32) # Id of the CheckoutCustomField}\n@optional {checkout_custom_field: map{label: str, type: str, area: str, required: bool, position: int(int32), deletable: bool, is_date_restricted: bool, custom_field_select_options: [str]}}\n@returns(200) {checkout_custom_field: map{id: int(int32), label: str, type: str, area: str, required: bool, position: int(int32), deletable: bool, app_id: int(int32)?, checkout_custom_field_select_options: [map]}} # OK\n@errors {404: CheckoutCustomField not found, invalid type, or it could not be saved.}\n\n@endpoint DELETE /checkout_custom_fields/{id}.json\n@desc Delete an existing CheckoutCustomField.\n@required {id: int(int32) # Id of the CheckoutCustomField}\n@returns(200) {message: str} # OK\n@errors {404: CheckoutCustomField not found or could not be deleted.}\n\n@endgroup\n\n@group countries.json\n@endpoint GET /countries.json\n@desc Retrieve all Countries.\n@returns(200) An array of Countries\n\n@endgroup\n\n@group countries\n@endpoint GET /countries/{country_code}.json\n@desc Retrieve a single Country information.\n@required {country_code: str # ISO3166 Country Code}\n@returns(200) {code: str, name: str} # A Country information object\n@errors {404: Country Not Found.}\n\n@endpoint GET /countries/{country_code}/regions.json\n@desc Retrieve all Regions from a single Country.\n@required {country_code: str # ISO3166 Country Code}\n@returns(200) An array of Regions from a single Country\n@errors {404: Country Not Found.}\n\n@endpoint GET /countries/{country_code}/regions/{region_code}/municipalities.json\n@desc Retrieve all Municipalities from a single Region.\n@required {country_code: str # ISO3166 Country Code, region_code: str # Region Code}\n@returns(200) An array of Municipalities from a single Region\n@errors {404: Country or Region Not Found.}\n\n@endpoint GET /countries/{country_code}/regions/{region_code}.json\n@desc Retrieve a single Region information object.\n@required {country_code: str # ISO3166 Country Code, region_code: str # Region Code}\n@returns(200) {code: str, name: str} # A Region information object\n@errors {404: Country or Region not found.}\n\n@endgroup\n\n@group taxes.json\n@endpoint GET /taxes.json\n@desc Retrieve all Taxes.\n@returns(200) An array of Taxes\n\n@endpoint POST /taxes.json\n@desc Create a new Tax.\n@optional {tax: map{country: str, name: str, region: str, category_id: int(int32), tax: num(float), fixed: bool, shipping: bool, product_type: str, kind: str, municipality: str}}\n@returns(200) {tax: map{id: int(int32), name: str, country: str, region: str, category_id: int(int32), tax_amount: num(float), fixed: bool, shipping: bool, product_type: str?, kind: str}} # OK\n@errors {404: Tax could not be saved (validation error or invalid category).}\n\n@endgroup\n\n@group taxes\n@endpoint GET /taxes/{id}.json\n@desc Retrieve a single Tax information.\n@required {id: int(int32) # Id of the Tax}\n@returns(200) {tax: map{id: int(int32), name: str, country: str, region: str, category_id: int(int32), tax_amount: num(float), fixed: bool, shipping: bool, product_type: str?, kind: str}} # A Tax information object\n@errors {404: Tax Not Found.}\n\n@endpoint PUT /taxes/{id}.json\n@desc Modify an existing Tax.\n@required {id: int(int32) # Id of the Tax}\n@optional {tax: map{country: str, name: str, region: str, category_id: int(int32), tax: num(float), fixed: bool, shipping: bool, product_type: str, kind: str, municipality: str}}\n@returns(200) {tax: map{id: int(int32), name: str, country: str, region: str, category_id: int(int32), tax_amount: num(float), fixed: bool, shipping: bool, product_type: str?, kind: str}} # OK\n@errors {404: Tax Not Found, or it could not be saved (validation error or invalid category).}\n\n@endpoint DELETE /taxes/{id}.json\n@desc Delete an existing Tax.\n@required {id: int(int32) # Id of the Tax}\n@returns(200) {message: str} # OK\n@errors {404: Tax Not Found, or it could not be deleted.}\n\n@endgroup\n\n@group store\n@endpoint POST /store/setup.json\n@desc Create a new store.\n@required {store: map{name!: str, country: str, theme: str}}\n@returns(201) {store: map{code: str, name: str, url: str, admin_url: str}, credentials: map{login: str, authtoken: str}} # Store created successfully.\n@errors {400: Invalid JSON body, missing or invalid store name, or invalid country code., 402: A paying subscription is required to create stores., 403: Store creation is available 24 hours after the first payment., 429: Store creation limit exceeded (5 per day).}\n\n@endgroup\n\n@group carts\n@endpoint GET /carts/{id}.json\n@desc Obtain information for a cart.\n@required {id: int(int32) # Id of the cart}\n@optional {locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language.}\n@returns(200) {order: map{id: int(int32), source: map{created_from: str, created_from_app_code: str, source_name: str, medium: str, campaign: str, referral_url: str, referral_code: str, user_agent: str, first_page_visited: str, first_page_visited_at: str, referral_source: str}, created_at: str, completed_at: str, currency: str, subtotal: num(float), tax: num(float), shipping_tax: num(float), shipping: num(float), shipping_required: bool, total: num(float), discount: num(float), shipping_discount: num(float), gift_cards_discount: num(float), fulfillment_status: str, shipping_method_id: int(int32), shipping_service_id: int(int32), shipping_method_name: str, payment_method_name: str, payment_method_type: str, payment_information: str, payment_notification_id: str, additional_information: str, duplicate_url: str, recovery_url: str, review_url: str, checkout_url: str, coupons: str, promotions: [map], customer: map{id: int(int32), email: str, phone: str, phone_prefix: str, ip: str, fullname: str}, shipping_branch: map{id: int(int32), name: str}, shipping_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, latitude: num, longitude: num, municipality: str, neighbourhood: str}, billing_address: map{name: str, surname: str, taxid: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, neighbourhood: str}, pickup_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, pickup_place_name: str, taxid: str, neighbourhood: str}, products: [map], additional_fields: [map], shipping_taxes: [map], fees: [map], status: str, status_name: str, tracking_url: str, tracking_company: str, tracking_number: str, shipping_option: str?, same_day_delivery: bool, shipment_status: str, shipment_status_enum: str, recovered_from: int(int32)?, external_shipping_rate_id: str, external_shipping_rate_description: str, billing_information: map{business_activity: str, company_name: str, taxpayer_type: str}, cart_id: int(int32)}} # OK\n@errors {404: Cart Not Found.}\n\n@endgroup\n\n@group order_documents.json\n@endpoint GET /order_documents.json\n@desc Retrieve all Documents from a Store.\n@optional {limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) An array of documents\n\n@endgroup\n\n@group products_locations.json\n@endpoint GET /products_locations.json\n@desc Stock by Product and Location\n@required {location_ids: [int] # List of location IDs (comma separated), product_ids: [int] # List of product IDs (comma separated)}\n@optional {variant_ids: [int] # List of variant IDs (comma separated)}\n@returns(200) Array of products locations\n@errors {400: location_ids or product_ids missing., 404: Stock location combinations not found.}\n\n@endpoint PUT /products_locations.json\n@desc Update Stock by Product and Location\n@required {location_id: int, product_id: int, stock_unlimited: bool, stock: int}\n@optional {variant_id: int}\n@returns(200) {message: str} # Stock location updated successfully.\n@errors {404: A required parameter is missing, or the Product, Variant or Location was not found., 500: Error while updating stock.}\n\n@endgroup\n\n@group orders\n@endpoint GET /orders/payment_notifications/{payment_notification_id}.json\n@desc Retrieve an Order by payment notification id.\n@required {payment_notification_id: str # Payment notification identifier of the Order}\n@optional {fields: str # Comma-separated list of fields to include in each Order. All fields except `cart_id` are returned when omitted. `gift_cards` returns `gift_cards_discount`, `taxes` returns `shipping_taxes` and `status` returns both `status` and `status_name`. Available fields: `id`, `source`, `cart_id`, `created_at`, `completed_at`, `currency`, `subtotal`, `tax`, `shipping_tax`, `shipping`, `shipping_required`, `total`, `discount`, `shipping_discount`, `gift_cards`, `fulfillment_status`, `shipping_method_id`, `shipping_service_id`, `shipping_method_name`, `payment_method_name`, `payment_method_type`, `payment_information`, `payment_notification_id`, `additional_information`, `duplicate_url`, `recovery_url`, `review_url`, `checkout_url`, `coupons`, `promotions`, `customer`, `shipping_branch`, `shipping_address`, `billing_address`, `pickup_address`, `products`, `additional_fields`, `taxes`, `status`, `tracking_url`, `tracking_company`, `tracking_number`, `shipping_option`, `same_day_delivery`, `shipment_status`, `shipment_status_enum`, `recovered_from`, `external_shipping_rate_id`, `external_shipping_rate_description`, `billing_information`., locale: str # Language of the translatable fields, one of the store's languages (e.g. `es`). Defaults to the store's default language.}\n@returns(200) {order: map{id: int(int32), source: map{created_from: str, created_from_app_code: str, source_name: str, medium: str, campaign: str, referral_url: str, referral_code: str, user_agent: str, first_page_visited: str, first_page_visited_at: str, referral_source: str}, created_at: str, completed_at: str, currency: str, subtotal: num(float), tax: num(float), shipping_tax: num(float), shipping: num(float), shipping_required: bool, total: num(float), discount: num(float), shipping_discount: num(float), gift_cards_discount: num(float), fulfillment_status: str, shipping_method_id: int(int32), shipping_service_id: int(int32), shipping_method_name: str, payment_method_name: str, payment_method_type: str, payment_information: str, payment_notification_id: str, additional_information: str, duplicate_url: str, recovery_url: str, review_url: str, checkout_url: str, coupons: str, promotions: [map], customer: map{id: int(int32), email: str, phone: str, phone_prefix: str, ip: str, fullname: str}, shipping_branch: map{id: int(int32), name: str}, shipping_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, latitude: num, longitude: num, municipality: str, neighbourhood: str}, billing_address: map{name: str, surname: str, taxid: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, neighbourhood: str}, pickup_address: map{name: str, surname: str, address: str, city: str, postal: str, region: str, country: str, country_code: str, region_code: str, street_number: str, complement: str, municipality: str, pickup_place_name: str, taxid: str, neighbourhood: str}, products: [map], additional_fields: [map], shipping_taxes: [map], fees: [map], status: str, status_name: str, tracking_url: str, tracking_company: str, tracking_number: str, shipping_option: str?, same_day_delivery: bool, shipment_status: str, shipment_status_enum: str, recovered_from: int(int32)?, external_shipping_rate_id: str, external_shipping_rate_description: str, billing_information: map{business_activity: str, company_name: str, taxpayer_type: str}, cart_id: int(int32)}} # OK\n@errors {404: Order Not Found.}\n\n@endgroup\n\n@group fulfillments\n@endpoint GET /fulfillments/search.json\n@desc Retrieve a Fulfillments List from a query.\n@optional {query: str # Tracking number, Order id or manifest id to search for., status_filters: str # Comma-separated shipment statuses: `requested`, `in_transit`, `delivered`, `failed`, `pickup_available`, `in_preparation`. `requested` also matches manual fulfillments without a status., fulfillment_type_filter: str # Comma-separated fulfillment types (see `type` in the Fulfillment)., tracking_company_filter: str # Comma-separated tracking companies. `manual` matches every company that is not a fulfillment service., dateFilter: str(today/yesterday/last7days/last30days/last90days/quarterToDate/yearToDate/blackFridayToCyberMonday/customDate) # Filter by creation date, in the store timezone. With `customDate`, use `initialDate` and `finalDate`., initialDate: str(date) # Start date (inclusive) in the format YYYY-MM-DD. Only used with `dateFilter=customDate` and `finalDate`., finalDate: str(date) # End date (inclusive) in the format YYYY-MM-DD. Only used with `dateFilter=customDate` and `initialDate`., lat: num(float) # Latitude of the center point. Used with `lon` and `radius` to keep fulfillments whose Order shipping address is within the radius., lon: num(float) # Longitude of the center point., radius: int # Radius in kilometers., filter_empty_addresses: bool=false # When `true`, only fulfillments whose Order has a shipping address are returned., limit: int=50 # Number of objects per page (maximum 100)., page: int=1 # Page number, starting at 1.}\n@returns(200) {count: int, order_fulfillments: [map]} # OK\n\n@endgroup\n\n@group taxes\n@endpoint GET /taxes/settings.json\n@desc Retrieve the Store's tax settings.\n@returns(200) {based_on: str, tax_on_product_price: bool, tax_on_shipping_price: bool, tax_exempt_eu_vat: bool} # OK\n\n@endgroup\n\n@group products\n@endpoint PUT /products/{id}/fields/{field_id}.json\n@desc Update the value of a Product Custom Field.\n@required {id: int(int32) # Id of the Product, field_id: int(int32) # Id of the Custom Field Value., field: map{value!: str}}\n@returns(200) {field: map{id: int(int32), custom_field_id: int(int32), type: str, label: str, value: str, value_id: int(int32)?, variant_id: int(int32)?, google_attribute_id: str?}} # OK\n@errors {400: No value provided., 404: Product or Custom Field Value Not Found.}\n\n@endpoint DELETE /products/{id}/fields/{field_id}.json\n@desc Delete the value of a Product Custom Field.\n@required {id: int(int32) # Id of the Product, field_id: int(int32) # Id of the Custom Field Value.}\n@returns(200) {message: str} # OK\n@errors {404: Product or Custom Field Value Not Found.}\n\n@endgroup\n\n@group customers\n@endpoint GET /customers/{id}/fields/count.json\n@desc Count the Customer Additional Fields of a Customer.\n@required {id: int(int32) # Id of the Customer}\n@returns(200) {count: int(int32)} # OK\n@errors {404: Customer Not Found.}\n\n@endgroup\n\n@group rates.json\n@endpoint GET /rates.json\n@desc Retrieve shipping rates for an Order.\n@required {id: int(int32) # Id of the Order (the `id` returned by the Orders endpoints), or the id of a Cart, type: str # Shipping Method type to calculate rates for (e.g. `tables`, `external`, `flat`)}\n@returns(200) {rates: [map]} # OK\n@errors {404: Missing parameters or Order not found.}\n\n@endgroup\n\n@end\n"}