openapi: 3.1.0 info: title: Commerce Layer addresses markets API version: 7.10.1 contact: name: API Support url: https://commercelayer.io email: support@commercelayer.io description: Headless Commerce for Global Brands. servers: - url: https://{your_organization_slug}.commercelayer.io/api description: API - url: https://core.commercelayer.io/users/sign_in description: Sign in - url: https://docs.commercelayer.io/api description: API reference security: - bearerAuth: [] tags: - name: markets description: resource type paths: /avalara_accounts/{avalaraAccountId}/markets: get: operationId: GET/avalaraAccountId/markets summary: Retrieve the markets associated to the avalara account description: Retrieve the markets associated to the avalara account tags: - markets parameters: - name: avalaraAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the avalara account /bing_geocoders/{bingGeocoderId}/markets: get: operationId: GET/bingGeocoderId/markets summary: Retrieve the markets associated to the bing geocoder description: Retrieve the markets associated to the bing geocoder tags: - markets parameters: - name: bingGeocoderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the bing geocoder /bundles/{bundleId}/market: get: operationId: GET/bundleId/market summary: Retrieve the market associated to the bundle description: Retrieve the market associated to the bundle tags: - markets parameters: - name: bundleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the bundle /buy_x_pay_y_promotions/{buyXPayYPromotionId}/market: get: operationId: GET/buyXPayYPromotionId/market summary: Retrieve the market associated to the buy x pay y promotion description: Retrieve the market associated to the buy x pay y promotion tags: - markets parameters: - name: buyXPayYPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the buy x pay y promotion /carrier_accounts/{carrierAccountId}/market: get: operationId: GET/carrierAccountId/market summary: Retrieve the market associated to the carrier account description: Retrieve the market associated to the carrier account tags: - markets parameters: - name: carrierAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the carrier account /customer_groups/{customerGroupId}/markets: get: operationId: GET/customerGroupId/markets summary: Retrieve the markets associated to the customer group description: Retrieve the markets associated to the customer group tags: - markets parameters: - name: customerGroupId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the customer group /customers/{customerId}/jwt_markets: get: operationId: GET/customerId/jwt_markets summary: Retrieve the jwt markets associated to the customer description: Retrieve the jwt markets associated to the customer tags: - markets parameters: - name: customerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The jwt_markets associated to the customer /discount_engines/{discountEngineId}/markets: get: operationId: GET/discountEngineId/markets summary: Retrieve the markets associated to the discount engine description: Retrieve the markets associated to the discount engine tags: - markets parameters: - name: discountEngineId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the discount engine /external_promotions/{externalPromotionId}/market: get: operationId: GET/externalPromotionId/market summary: Retrieve the market associated to the external promotion description: Retrieve the market associated to the external promotion tags: - markets parameters: - name: externalPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the external promotion /external_tax_calculators/{externalTaxCalculatorId}/markets: get: operationId: GET/externalTaxCalculatorId/markets summary: Retrieve the markets associated to the external tax calculator description: Retrieve the markets associated to the external tax calculator tags: - markets parameters: - name: externalTaxCalculatorId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the external tax calculator /fixed_amount_promotions/{fixedAmountPromotionId}/market: get: operationId: GET/fixedAmountPromotionId/market summary: Retrieve the market associated to the fixed amount promotion description: Retrieve the market associated to the fixed amount promotion tags: - markets parameters: - name: fixedAmountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the fixed amount promotion /fixed_price_promotions/{fixedPricePromotionId}/market: get: operationId: GET/fixedPricePromotionId/market summary: Retrieve the market associated to the fixed price promotion description: Retrieve the market associated to the fixed price promotion tags: - markets parameters: - name: fixedPricePromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the fixed price promotion /free_gift_promotions/{freeGiftPromotionId}/market: get: operationId: GET/freeGiftPromotionId/market summary: Retrieve the market associated to the free gift promotion description: Retrieve the market associated to the free gift promotion tags: - markets parameters: - name: freeGiftPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the free gift promotion /free_shipping_promotions/{freeShippingPromotionId}/market: get: operationId: GET/freeShippingPromotionId/market summary: Retrieve the market associated to the free shipping promotion description: Retrieve the market associated to the free shipping promotion tags: - markets parameters: - name: freeShippingPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the free shipping promotion /geocoders/{geocoderId}/markets: get: operationId: GET/geocoderId/markets summary: Retrieve the markets associated to the geocoder description: Retrieve the markets associated to the geocoder tags: - markets parameters: - name: geocoderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the geocoder /gift_cards/{giftCardId}/market: get: operationId: GET/giftCardId/market summary: Retrieve the market associated to the gift card description: Retrieve the market associated to the gift card tags: - markets parameters: - name: giftCardId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the gift card /google_geocoders/{googleGeocoderId}/markets: get: operationId: GET/googleGeocoderId/markets summary: Retrieve the markets associated to the google geocoder description: Retrieve the markets associated to the google geocoder tags: - markets parameters: - name: googleGeocoderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the google geocoder /in_stock_subscriptions/{inStockSubscriptionId}/market: get: operationId: GET/inStockSubscriptionId/market summary: Retrieve the market associated to the in stock subscription description: Retrieve the market associated to the in stock subscription tags: - markets parameters: - name: inStockSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the in stock subscription /manual_tax_calculators/{manualTaxCalculatorId}/markets: get: operationId: GET/manualTaxCalculatorId/markets summary: Retrieve the markets associated to the manual tax calculator description: Retrieve the markets associated to the manual tax calculator tags: - markets parameters: - name: manualTaxCalculatorId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the manual tax calculator /markets: get: operationId: GET/markets summary: List all markets description: List all markets tags: - markets responses: '200': description: A list of market objects content: application/vnd.api+json: schema: $ref: '#/components/schemas/marketResponseList' post: operationId: POST/markets summary: Create a market description: Create a market tags: - markets requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/marketCreate' responses: '201': description: The created market object content: application/vnd.api+json: schema: $ref: '#/components/schemas/marketResponse' /markets/{marketId}: get: operationId: GET/markets/marketId summary: Retrieve a market description: Retrieve a market tags: - markets parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market object content: application/vnd.api+json: schema: $ref: '#/components/schemas/marketResponse' patch: operationId: PATCH/markets/marketId summary: Update a market description: Update a market tags: - markets parameters: - name: marketId in: path schema: type: string required: true description: The resource's id requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/marketUpdate' responses: '200': description: The updated market object content: application/vnd.api+json: schema: $ref: '#/components/schemas/marketResponse' delete: operationId: DELETE/markets/marketId summary: Delete a market description: Delete a market tags: - markets parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '204': description: No content /order_subscriptions/{orderSubscriptionId}/market: get: operationId: GET/orderSubscriptionId/market summary: Retrieve the market associated to the order subscription description: Retrieve the market associated to the order subscription tags: - markets parameters: - name: orderSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the order subscription /orders/{orderId}/market: get: operationId: GET/orderId/market summary: Retrieve the market associated to the order description: Retrieve the market associated to the order tags: - markets parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the order /payment_methods/{paymentMethodId}/market: get: operationId: GET/paymentMethodId/market summary: Retrieve the market associated to the payment method description: Retrieve the market associated to the payment method tags: - markets parameters: - name: paymentMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the payment method /percentage_discount_promotions/{percentageDiscountPromotionId}/market: get: operationId: GET/percentageDiscountPromotionId/market summary: Retrieve the market associated to the percentage discount promotion description: Retrieve the market associated to the percentage discount promotion tags: - markets parameters: - name: percentageDiscountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the percentage discount promotion /price_list_schedulers/{priceListSchedulerId}/market: get: operationId: GET/priceListSchedulerId/market summary: Retrieve the market associated to the price list scheduler description: Retrieve the market associated to the price list scheduler tags: - markets parameters: - name: priceListSchedulerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the price list scheduler /prices/{priceId}/jwt_markets: get: operationId: GET/priceId/jwt_markets summary: Retrieve the jwt markets associated to the price description: Retrieve the jwt markets associated to the price tags: - markets parameters: - name: priceId in: path schema: type: string required: true description: The resource's id responses: '200': description: The jwt_markets associated to the price /promotions/{promotionId}/market: get: operationId: GET/promotionId/market summary: Retrieve the market associated to the promotion description: Retrieve the market associated to the promotion tags: - markets parameters: - name: promotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the promotion /shipping_methods/{shippingMethodId}/market: get: operationId: GET/shippingMethodId/market summary: Retrieve the market associated to the shipping method description: Retrieve the market associated to the shipping method tags: - markets parameters: - name: shippingMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the shipping method /sku_options/{skuOptionId}/market: get: operationId: GET/skuOptionId/market summary: Retrieve the market associated to the SKU option description: Retrieve the market associated to the SKU option tags: - markets parameters: - name: skuOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the SKU option /skus/{skuId}/jwt_markets: get: operationId: GET/skuId/jwt_markets summary: Retrieve the jwt markets associated to the SKU description: Retrieve the jwt markets associated to the SKU tags: - markets parameters: - name: skuId in: path schema: type: string required: true description: The resource's id responses: '200': description: The jwt_markets associated to the SKU /stores/{storeId}/market: get: operationId: GET/storeId/market summary: Retrieve the market associated to the store description: Retrieve the market associated to the store tags: - markets parameters: - name: storeId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the store /stripe_tax_accounts/{stripeTaxAccountId}/markets: get: operationId: GET/stripeTaxAccountId/markets summary: Retrieve the markets associated to the stripe tax account description: Retrieve the markets associated to the stripe tax account tags: - markets parameters: - name: stripeTaxAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the stripe tax account /subscription_models/{subscriptionModelId}/markets: get: operationId: GET/subscriptionModelId/markets summary: Retrieve the markets associated to the subscription model description: Retrieve the markets associated to the subscription model tags: - markets parameters: - name: subscriptionModelId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the subscription model /talon_one_accounts/{talonOneAccountId}/markets: get: operationId: GET/talonOneAccountId/markets summary: Retrieve the markets associated to the talon one account description: Retrieve the markets associated to the talon one account tags: - markets parameters: - name: talonOneAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the talon one account /tax_calculators/{taxCalculatorId}/markets: get: operationId: GET/taxCalculatorId/markets summary: Retrieve the markets associated to the tax calculator description: Retrieve the markets associated to the tax calculator tags: - markets parameters: - name: taxCalculatorId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the tax calculator /taxjar_accounts/{taxjarAccountId}/markets: get: operationId: GET/taxjarAccountId/markets summary: Retrieve the markets associated to the taxjar account description: Retrieve the markets associated to the taxjar account tags: - markets parameters: - name: taxjarAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the taxjar account /vertex_accounts/{vertexAccountId}/markets: get: operationId: GET/vertexAccountId/markets summary: Retrieve the markets associated to the vertex account description: Retrieve the markets associated to the vertex account tags: - markets parameters: - name: vertexAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The markets associated to the vertex account components: schemas: marketResponse: type: object properties: data: type: object properties: id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN type: type: string description: The resource's type enum: - markets links: type: object properties: self: type: string description: URL attributes: $ref: '#/components/schemas/market/properties/data/properties/attributes' relationships: type: object properties: merchant: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - merchant id: type: string description: The resource ID price_list: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - price_list id: type: string description: The resource ID base_price_list: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - base_price_list id: type: string description: The resource ID inventory_model: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - inventory_model id: type: string description: The resource ID subscription_model: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - subscription_model id: type: string description: The resource ID discount_engine: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - discount_engine id: type: string description: The resource ID tax_calculator: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - tax_calculator id: type: string description: The resource ID customer_group: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - customer_group id: type: string description: The resource ID geocoder: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - geocoder id: type: string description: The resource ID default_shipping_method: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - default_shipping_method id: type: string description: The resource ID default_payment_method: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - default_payment_method id: type: string description: The resource ID stores: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - stores id: type: string description: The resource ID price_list_schedulers: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - price_list_schedulers id: type: string description: The resource ID attachments: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: The resource ID event_stores: type: object properties: links: type: object properties: self: type: string description: URL related: type: string description: URL data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: The resource ID vertexAccount: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - vertex_accounts attributes: type: object properties: name: type: string description: The tax calculator's internal name. example: Personal tax calculator nullable: false type: type: string description: The tax calculator's type. example: avalara_accounts nullable: false enum: - avalara_accounts - stripe_tax_accounts - vertex_accounts - taxjar_accounts - manual_tax_calculators - external_tax_calculators created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true kind: type: string description: The Vertex account kind. One of 'cloud', 'on_demand', or 'on_premise'. example: cloud nullable: true enum: - cloud - on_demand - on_premise baseurl: type: string description: The Vertex API baseurl, optional for 'cloud' kind. example: yourbaseurl nullable: true api_endpoint: type: string description: The API endpoint as computed by specified kind and baseurl. example: https://my_baseurl.ondemand.vertexinc.com nullable: true commit_invoice: type: boolean description: Indicates if the transaction will be recorded and visible on the Vertex website. example: true nullable: true token_expires_at: type: string description: The expiration date/time of the access token. example: '2018-01-02T12:00:00.000Z' nullable: true relationships: type: object properties: markets: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attachments: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN events: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - events id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN market: properties: data: properties: attributes: type: object properties: number: type: integer description: Unique identifier for the market (numeric). example: 1234 nullable: true name: type: string description: The market's internal name. example: EU Market nullable: false code: type: string description: A string that you can use to identify the market (must be unique within the environment). example: europe1 nullable: true facebook_pixel_id: type: string description: The Facebook Pixed ID. example: '1234567890' nullable: true checkout_url: type: string description: The checkout URL for this market. example: https://checkout.yourbrand.com/:order_id nullable: true external_prices_url: type: string description: The URL used to overwrite prices by an external source. example: https://external_prices.yourbrand.com nullable: true external_order_validation_url: type: string description: The URL used to validate orders by an external source. example: https://external_validation.yourbrand.com nullable: true private: type: boolean description: Indicates if market belongs to a customer_group. example: true nullable: true shipping_cost_cutoff: type: integer description: When specified indicates the maximum number of shipping line items with cost that will be added to an order. example: 3 nullable: true disabled_at: type: string description: Time at which this resource was disabled. example: '2018-01-01T12:00:00.000Z' nullable: true shared_secret: type: string description: The shared secret used to sign the external request payload. example: 1c0994cc4e996e8c6ee56a2198f66f3c nullable: false external_includes: type: array description: List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided. example: - order.line_item_options nullable: true items: type: string created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true marketCreate: required: - data type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - markets attributes: type: object properties: name: type: string description: The market's internal name. example: EU Market code: type: string description: A string that you can use to identify the market (must be unique within the environment). example: europe1 facebook_pixel_id: type: string description: The Facebook Pixed ID. example: '1234567890' checkout_url: type: string description: The checkout URL for this market. example: https://checkout.yourbrand.com/:order_id external_prices_url: type: string description: The URL used to overwrite prices by an external source. example: https://external_prices.yourbrand.com external_order_validation_url: type: string description: The URL used to validate orders by an external source. example: https://external_validation.yourbrand.com shipping_cost_cutoff: type: integer description: When specified indicates the maximum number of shipping line items with cost that will be added to an order. example: 3 _disable: type: boolean description: Send this attribute if you want to mark this resource as disabled. example: true _enable: type: boolean description: Send this attribute if you want to mark this resource as enabled. example: true external_includes: type: array description: List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided. example: - order.line_item_options items: type: string reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar required: - name relationships: type: object properties: merchant: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - merchants id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN price_list: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - price_lists id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN inventory_model: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - inventory_models id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN subscription_model: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - subscription_models id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN discount_engine: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - discount_engines id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN tax_calculator: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - avalara_accounts - stripe_tax_accounts - vertex_accounts - taxjar_accounts - manual_tax_calculators - external_tax_calculators id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/avalaraAccount' - $ref: '#/components/schemas/stripeTaxAccount' - $ref: '#/components/schemas/vertexAccount' - $ref: '#/components/schemas/taxjarAccount' - $ref: '#/components/schemas/manualTaxCalculator' - $ref: '#/components/schemas/externalTaxCalculator' customer_group: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customer_groups id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN geocoder: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - geocoders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN default_shipping_method: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - shipping_methods id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN default_payment_method: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_methods id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN required: - merchant - price_list - inventory_model marketResponseList: type: object properties: data: type: array items: $ref: '#/components/schemas/marketResponse/properties/data' marketUpdate: required: - data type: object properties: data: type: object required: - type - id - attributes properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attributes: type: object properties: name: type: string description: The market's internal name. example: EU Market nullable: false code: type: string description: A string that you can use to identify the market (must be unique within the environment). example: europe1 nullable: true facebook_pixel_id: type: string description: The Facebook Pixed ID. example: '1234567890' nullable: true checkout_url: type: string description: The checkout URL for this market. example: https://checkout.yourbrand.com/:order_id nullable: true external_prices_url: type: string description: The URL used to overwrite prices by an external source. example: https://external_prices.yourbrand.com nullable: true external_order_validation_url: type: string description: The URL used to validate orders by an external source. example: https://external_validation.yourbrand.com nullable: true shipping_cost_cutoff: type: integer description: When specified indicates the maximum number of shipping line items with cost that will be added to an order. example: 3 nullable: true _disable: type: boolean description: Send this attribute if you want to mark this resource as disabled. example: true nullable: false _enable: type: boolean description: Send this attribute if you want to mark this resource as enabled. example: true nullable: false external_includes: type: array description: List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided. example: - order.line_item_options nullable: true items: type: string reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: merchant: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - merchants id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN price_list: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - price_lists id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN inventory_model: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - inventory_models id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN subscription_model: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - subscription_models id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN discount_engine: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - discount_engines id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN tax_calculator: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - avalara_accounts - stripe_tax_accounts - vertex_accounts - taxjar_accounts - manual_tax_calculators - external_tax_calculators id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/avalaraAccount' - $ref: '#/components/schemas/stripeTaxAccount' - $ref: '#/components/schemas/vertexAccount' - $ref: '#/components/schemas/taxjarAccount' - $ref: '#/components/schemas/manualTaxCalculator' - $ref: '#/components/schemas/externalTaxCalculator' customer_group: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customer_groups id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN geocoder: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - geocoders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN default_shipping_method: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - shipping_methods id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN default_payment_method: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_methods id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN stripeTaxAccount: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - stripe_tax_accounts attributes: type: object properties: name: type: string description: The tax calculator's internal name. example: Personal tax calculator nullable: false type: type: string description: The tax calculator's type. example: avalara_accounts nullable: false enum: - avalara_accounts - stripe_tax_accounts - vertex_accounts - taxjar_accounts - manual_tax_calculators - external_tax_calculators created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true commit_invoice: type: boolean description: Indicates if the transaction will be recorded and visible on the Stripe website. example: true nullable: true relationships: type: object properties: markets: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attachments: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN events: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - events id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN tax_categories: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tax_categories id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN externalTaxCalculator: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - external_tax_calculators attributes: type: object properties: name: type: string description: The tax calculator's internal name. example: Personal tax calculator nullable: false type: type: string description: The tax calculator's type. example: avalara_accounts nullable: false enum: - avalara_accounts - stripe_tax_accounts - vertex_accounts - taxjar_accounts - manual_tax_calculators - external_tax_calculators created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true circuit_state: type: string description: The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made. example: closed nullable: true circuit_failure_count: type: integer description: The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. example: 5 nullable: true shared_secret: type: string description: The shared secret used to sign the external request payload. example: 1c0994cc4e996e8c6ee56a2198f66f3c nullable: false external_includes: type: array description: List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided. example: - order.line_item_options nullable: true items: type: string tax_calculator_url: type: string description: The URL to the service that will compute the taxes. example: https://external_calculator.yourbrand.com nullable: false relationships: type: object properties: markets: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attachments: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN events: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - events id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN taxjarAccount: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - taxjar_accounts attributes: type: object properties: name: type: string description: The tax calculator's internal name. example: Personal tax calculator nullable: false type: type: string description: The tax calculator's type. example: avalara_accounts nullable: false enum: - avalara_accounts - stripe_tax_accounts - vertex_accounts - taxjar_accounts - manual_tax_calculators - external_tax_calculators created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: markets: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attachments: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN events: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - events id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN tax_categories: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tax_categories id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN manualTaxCalculator: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - manual_tax_calculators attributes: type: object properties: name: type: string description: The tax calculator's internal name. example: Personal tax calculator nullable: false type: type: string description: The tax calculator's type. example: avalara_accounts nullable: false enum: - avalara_accounts - stripe_tax_accounts - vertex_accounts - taxjar_accounts - manual_tax_calculators - external_tax_calculators created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true relationships: type: object properties: markets: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attachments: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN events: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - events id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN tax_rules: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tax_rules id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN avalaraAccount: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - avalara_accounts attributes: type: object properties: name: type: string description: The tax calculator's internal name. example: Personal tax calculator nullable: false type: type: string description: The tax calculator's type. example: avalara_accounts nullable: false enum: - avalara_accounts - stripe_tax_accounts - vertex_accounts - taxjar_accounts - manual_tax_calculators - external_tax_calculators created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true username: type: string description: The Avalara account username. example: user@mydomain.com nullable: false company_code: type: string description: The Avalara company code. example: MYCOMPANY nullable: false commit_invoice: type: boolean description: Indicates if the transaction will be recorded and visible on the Avalara website. example: true nullable: true ddp: type: boolean description: Indicates if the seller is responsible for paying/remitting the customs duty & import tax to the customs authorities. example: true nullable: true relationships: type: object properties: markets: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - markets id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attachments: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - attachments id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN events: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - events id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN event_stores: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - event_stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN tax_categories: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tax_categories id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT