openapi: 3.1.0 info: title: Commerce Layer addresses links 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: links description: resource type paths: /links: get: operationId: GET/links summary: List all links description: List all links tags: - links responses: '200': description: A list of link objects content: application/vnd.api+json: schema: $ref: '#/components/schemas/linkResponseList' post: operationId: POST/links summary: Create a link description: Create a link tags: - links requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/linkCreate' responses: '201': description: The created link object content: application/vnd.api+json: schema: $ref: '#/components/schemas/linkResponse' /links/{linkId}: get: operationId: GET/links/linkId summary: Retrieve a link description: Retrieve a link tags: - links parameters: - name: linkId in: path schema: type: string required: true description: The resource's id responses: '200': description: The link object content: application/vnd.api+json: schema: $ref: '#/components/schemas/linkResponse' patch: operationId: PATCH/links/linkId summary: Update a link description: Update a link tags: - links parameters: - name: linkId in: path schema: type: string required: true description: The resource's id requestBody: required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/linkUpdate' responses: '200': description: The updated link object content: application/vnd.api+json: schema: $ref: '#/components/schemas/linkResponse' delete: operationId: DELETE/links/linkId summary: Delete a link description: Delete a link tags: - links parameters: - name: linkId in: path schema: type: string required: true description: The resource's id responses: '204': description: No content /orders/{orderId}/links: get: operationId: GET/orderId/links summary: Retrieve the links associated to the order description: Retrieve the links associated to the order tags: - links parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The links associated to the order /sku_lists/{skuListId}/links: get: operationId: GET/skuListId/links summary: Retrieve the links associated to the SKU list description: Retrieve the links associated to the SKU list tags: - links parameters: - name: skuListId in: path schema: type: string required: true description: The resource's id responses: '200': description: The links associated to the SKU list /skus/{skuId}/links: get: operationId: GET/skuId/links summary: Retrieve the links associated to the SKU description: Retrieve the links associated to the SKU tags: - links parameters: - name: skuId in: path schema: type: string required: true description: The resource's id responses: '200': description: The links associated to the SKU components: schemas: satispayPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - satispay_payments attributes: type: object properties: payment_id: type: string description: The payment unique identifier. example: xxxx-yyyy-zzzz nullable: true flow: type: string description: The Satispay payment flow, inspect gateway API details for more information. example: MATCH_CODE nullable: true status: type: string description: The Satispay payment status. example: PENDING nullable: true redirect_url: type: string description: The url to redirect the customer after the payment flow is completed. example: http://commercelayer.dev/satispay/redirect nullable: true payment_url: type: string description: Redirect url to the payment page. example: https://online.satispay.com/pay/xxxx-yyyy-zzzz?redirect_url={redirect_url} nullable: true payment_response: type: object description: The Satispay payment response, used to fetch internal data. example: foo: bar nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways 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 wireTransfer: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - wire_transfers attributes: type: object properties: payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders 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 capture: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - captures attributes: type: object properties: number: type: string description: The transaction number, auto generated. example: 42/T/001 nullable: false type: type: string description: The transaction's type. example: authorizations nullable: false enum: - authorizations - voids - captures - refunds payment_method_type: type: string description: Information about the payment method used in the transaction. example: credit card nullable: true currency_code: type: string description: The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order. example: EUR nullable: false amount_cents: type: integer description: The transaction amount, in cents. example: 1500 nullable: false amount_float: type: number description: The transaction amount, float. example: 15.0 nullable: false formatted_amount: type: string description: The transaction amount, formatted. example: €15,00 nullable: false succeeded: type: boolean description: Indicates if the transaction is successful. example: false nullable: false message: type: string description: The message returned by the payment gateway. example: Accepted nullable: true error_code: type: string description: The error code, if any, returned by the payment gateway. example: '00001' nullable: true error_detail: type: string description: The error detail, if any, returned by the payment gateway. example: Already settled nullable: true token: type: string description: The token identifying the transaction, returned by the payment gateway. example: xxxx-yyyy-zzzz nullable: true gateway_transaction_id: type: string description: The ID identifying the transaction, returned by the payment gateway. example: xxxx-yyyy-zzzz nullable: true 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 refund_amount_cents: type: integer description: The amount to be refunded, in cents. example: 500 nullable: true refund_amount_float: type: number description: The amount to be refunded, float. example: 5.0 nullable: true formatted_refund_amount: type: string description: The amount to be refunded, formatted. example: €5,00 nullable: true refund_balance_cents: type: integer description: The balance to be refunded, in cents. example: 1000 nullable: true refund_balance_float: type: number description: The balance to be refunded, float. example: 10.0 nullable: true formatted_refund_balance: type: string description: The balance to be refunded, formatted. example: €10,00 nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_source: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - adyen_payments - axerve_payments - braintree_payments - checkout_com_payments - external_payments - klarna_payments - paypal_payments - satispay_payments - stripe_payments - wire_transfers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/adyenPayment' - $ref: '#/components/schemas/axervePayment' - $ref: '#/components/schemas/braintreePayment' - $ref: '#/components/schemas/checkoutComPayment' - $ref: '#/components/schemas/externalPayment' - $ref: '#/components/schemas/klarnaPayment' - $ref: '#/components/schemas/paypalPayment' - $ref: '#/components/schemas/satispayPayment' - $ref: '#/components/schemas/stripePayment' - $ref: '#/components/schemas/wireTransfer' 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 reference_authorization: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - authorizations id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN refunds: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - refunds id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN return: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - returns id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN order: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - orders attributes: type: object properties: number: type: string description: The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels. example: '1234' nullable: true affiliate_code: type: string description: The affiliate code, if any, to track commissions using any third party services. example: xxxx-yyyy-zzzz nullable: true autorefresh: type: boolean description: Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster). example: true nullable: true place_async: type: boolean description: Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards. example: true nullable: true status: type: string description: The order status. One of 'draft' (default), 'pending', 'editing', 'placing', 'placed', 'approved', or 'cancelled'. example: draft nullable: false enum: - draft - pending - editing - placing - placed - approved - cancelled payment_status: type: string description: The order payment status. One of 'unpaid' (default), 'authorized', 'partially_authorized', 'paid', 'partially_paid', 'voided', 'partially_voided', 'refunded', 'partially_refunded', or 'free'. example: unpaid nullable: false enum: - unpaid - authorized - partially_authorized - paid - partially_paid - voided - partially_voided - refunded - partially_refunded - free fulfillment_status: type: string description: The order fulfillment status. One of 'unfulfilled' (default), 'in_progress', 'fulfilled', or 'not_required'. example: unfulfilled nullable: false enum: - unfulfilled - in_progress - fulfilled - not_required guest: type: boolean description: Indicates if the order has been placed as guest. example: true nullable: true editable: type: boolean description: Indicates if the order can be edited. example: true nullable: true customer_email: type: string description: The email address of the associated customer. When creating or updating an order, this is a shortcut to find or create the associated customer by email. example: john@example.com nullable: true customer_type: type: string description: The type of the associated customer. One of 'new', or 'returning'. example: returning nullable: true enum: - new - returning language_code: type: string description: The preferred language code (ISO 639-1) to be used when communicating with the customer. This can be useful when sending the order to 3rd party marketing tools and CRMs. If the language is supported, the hosted checkout will be localized accordingly. example: it nullable: true currency_code: type: string description: The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the order's market. example: EUR nullable: true tax_included: type: boolean description: Indicates if taxes are included in the order amounts, automatically inherited from the order's price list. example: true nullable: true tax_rate: type: number description: The tax rate for this order (if calculated). example: 0.22 nullable: true freight_taxable: type: boolean description: Indicates if taxes are applied to shipping costs. example: true nullable: true payment_method_taxable: type: boolean description: Indicates if taxes are applied to payment methods costs. example: true nullable: true adjustment_taxable: type: boolean description: Indicates if taxes are applied to positive adjustments. example: true nullable: true gift_card_taxable: type: boolean description: Indicates if taxes are applied to purchased gift cards. example: false nullable: true requires_billing_info: type: boolean description: Indicates if the billing address associated to this order requires billing info to be present. example: false nullable: true country_code: type: string description: The international 2-letter country code as defined by the ISO 3166-1 standard, automatically inherited from the order's shipping or billing addresses. example: IT nullable: true shipping_country_code_lock: type: string description: The country code that you want the shipping address to be locked to. This can be useful to make sure the shipping address belongs to a given shipping country, e.g. the one selected in a country selector page. Not relevant if order contains only digital products. example: IT nullable: true coupon_code: type: string description: The coupon code to be used for the order. If valid, it triggers a promotion adding a discount line item to the order. example: SUMMERDISCOUNT nullable: true gift_card_code: type: string description: The gift card code (at least the first 8 characters) to be used for the order. If valid, it uses the gift card balance to pay for the order. example: cc92c23e-967e-48b2-a323-59add603301f nullable: true subtotal_amount_cents: type: integer description: The sum of all the SKU line items total amounts, in cents. example: 5000 nullable: true subtotal_amount_float: type: number description: The sum of all the SKU line items total amounts, float. example: 50.0 nullable: true formatted_subtotal_amount: type: string description: The sum of all the SKU line items total amounts, formatted. example: €50,00 nullable: true shipping_amount_cents: type: integer description: The sum of all the shipping costs, in cents. example: 1200 nullable: true shipping_amount_float: type: number description: The sum of all the shipping costs, float. example: 12.0 nullable: true formatted_shipping_amount: type: string description: The sum of all the shipping costs, formatted. example: €12,00 nullable: true payment_method_amount_cents: type: integer description: The payment method costs, in cents. example: 0 nullable: true payment_method_amount_float: type: number description: The payment method costs, float. example: 0.0 nullable: true formatted_payment_method_amount: type: string description: The payment method costs, formatted. example: €0,00 nullable: true discount_amount_cents: type: integer description: The sum of all the discounts applied to the order, in cents (negative amount). example: -500 nullable: true discount_amount_float: type: number description: The sum of all the discounts applied to the order, float. example: -5.0 nullable: true formatted_discount_amount: type: string description: The sum of all the discounts applied to the order, formatted. example: -€5,00 nullable: true adjustment_amount_cents: type: integer description: The sum of all the adjustments applied to the order, in cents. example: 1500 nullable: true adjustment_amount_float: type: number description: The sum of all the adjustments applied to the order, float. example: 15.0 nullable: true formatted_adjustment_amount: type: string description: The sum of all the adjustments applied to the order, formatted. example: €15,00 nullable: true gift_card_amount_cents: type: integer description: The sum of all the gift_cards applied to the order, in cents. example: 1500 nullable: true gift_card_amount_float: type: number description: The sum of all the gift_cards applied to the order, float. example: 15.0 nullable: true formatted_gift_card_amount: type: string description: The sum of all the gift_cards applied to the order, formatted. example: €15,00 nullable: true total_tax_amount_cents: type: integer description: The sum of all the taxes applied to the order, in cents. example: 1028 nullable: true total_tax_amount_float: type: number description: The sum of all the taxes applied to the order, float. example: 10.28 nullable: true formatted_total_tax_amount: type: string description: The sum of all the taxes applied to the order, formatted. example: €10,28 nullable: true subtotal_tax_amount_cents: type: integer description: The taxes applied to the order's subtotal, in cents. example: 902 nullable: true subtotal_tax_amount_float: type: number description: The taxes applied to the order's subtotal, float. example: 9.02 nullable: true formatted_subtotal_tax_amount: type: string description: The taxes applied to the order's subtotal, formatted. example: €9,02 nullable: true shipping_tax_amount_cents: type: integer description: The taxes applied to the order's shipping costs, in cents. example: 216 nullable: true shipping_tax_amount_float: type: number description: The taxes applied to the order's shipping costs, float. example: 2.16 nullable: true formatted_shipping_tax_amount: type: string description: The taxes applied to the order's shipping costs, formatted. example: €2,16 nullable: true payment_method_tax_amount_cents: type: integer description: The taxes applied to the order's payment method costs, in cents. example: 0 nullable: true payment_method_tax_amount_float: type: number description: The taxes applied to the order's payment method costs, float. example: 0.0 nullable: true formatted_payment_method_tax_amount: type: string description: The taxes applied to the order's payment method costs, formatted. example: €0,00 nullable: true adjustment_tax_amount_cents: type: integer description: The taxes applied to the order adjustments, in cents. example: 900 nullable: true adjustment_tax_amount_float: type: number description: The taxes applied to the order adjustments, float. example: 9.0 nullable: true formatted_adjustment_tax_amount: type: string description: The taxes applied to the order adjustments, formatted. example: €9,00 nullable: true total_amount_cents: type: integer description: The order's total amount, in cents. example: 5700 nullable: true total_amount_float: type: number description: The order's total amount, float. example: 57.0 nullable: true formatted_total_amount: type: string description: The order's total amount, formatted. example: €57,00 nullable: true total_taxable_amount_cents: type: integer description: The order's total taxable amount, in cents (without discounts). example: 4672 nullable: true total_taxable_amount_float: type: number description: The order's total taxable amount, float. example: 46.72 nullable: true formatted_total_taxable_amount: type: string description: The order's total taxable amount, formatted. example: €46,72 nullable: true subtotal_taxable_amount_cents: type: integer description: The order's subtotal taxable amount, in cents (equal to subtotal_amount_cents when prices don't include taxes). example: 4098 nullable: true subtotal_taxable_amount_float: type: number description: The order's subtotal taxable amount, float. example: 40.98 nullable: true formatted_subtotal_taxable_amount: type: string description: The order's subtotal taxable amount, formatted. example: €40,98 nullable: true shipping_taxable_amount_cents: type: integer description: The order's shipping taxable amount, in cents (equal to shipping_amount_cents when prices don't include taxes). example: 984 nullable: true shipping_taxable_amount_float: type: number description: The order's shipping taxable amount, float. example: 9.84 nullable: true formatted_shipping_taxable_amount: type: string description: The order's shipping taxable amount, formatted. example: €9,84 nullable: true payment_method_taxable_amount_cents: type: integer description: The order's payment method taxable amount, in cents (equal to payment_method_amount_cents when prices don't include taxes). example: 0 nullable: true payment_method_taxable_amount_float: type: number description: The order's payment method taxable amount, float. example: 0.0 nullable: true formatted_payment_method_taxable_amount: type: string description: The order's payment method taxable amount, formatted. example: €0,00 nullable: true adjustment_taxable_amount_cents: type: integer description: The order's adjustment taxable amount, in cents (equal to discount_adjustment_cents when prices don't include taxes). example: 120 nullable: true adjustment_taxable_amount_float: type: number description: The order's adjustment taxable amount, float. example: 1.2 nullable: true formatted_adjustment_taxable_amount: type: string description: The order's adjustment taxable amount, formatted. example: €1,20 nullable: true total_amount_with_taxes_cents: type: integer description: The order's total amount (when prices include taxes) or the order's total + taxes amount (when prices don't include taxes, e.g. US Markets or B2B). example: 5700 nullable: true total_amount_with_taxes_float: type: number description: The order's total amount with taxes, float. example: 57.0 nullable: true formatted_total_amount_with_taxes: type: string description: The order's total amount with taxes, formatted. example: €57,00 nullable: true fees_amount_cents: type: integer description: The fees amount that is applied by Commerce Layer, in cents. example: 0 nullable: true fees_amount_float: type: number description: The fees amount that is applied by Commerce Layer, float. example: 0.0 nullable: true formatted_fees_amount: type: string description: The fees amount that is applied by Commerce Layer, formatted. example: €0,00 nullable: true duty_amount_cents: type: integer description: The duty amount that is calculated by external services, in cents. example: 0 nullable: true duty_amount_float: type: number description: The duty amount that is calculated by external services, float. example: 0.0 nullable: true formatted_duty_amount: type: string description: The duty amount that is calculated by external services, formatted. example: €0,00 nullable: true place_total_amount_cents: type: integer description: The total amount at place time, in cents, which is used internally for editing. example: 0 nullable: true place_total_amount_float: type: number description: The total amount at place time, float. example: 0.0 nullable: true formatted_place_total_amount: type: string description: The total amount at place time, formatted. example: €0,00 nullable: true skus_count: type: integer description: The total number of SKUs in the order's line items. This can be useful to display a preview of the customer shopping cart content. example: 2 nullable: true line_item_options_count: type: integer description: The total number of line item options. This can be useful to display a preview of the customer shopping cart content. example: 1 nullable: true shipments_count: type: integer description: The total number of shipments. This can be useful to manage the shipping method(s) selection during checkout. example: 1 nullable: true tax_calculations_count: type: integer description: The total number of tax calculations. This can be useful to monitor external tax service usage. example: 1 nullable: true validations_count: type: integer description: The total number of external validation performed. This can be useful to monitor if external validation has been triggered. example: 1 nullable: true errors_count: type: integer description: The total number of resource errors. example: 1 nullable: true payment_source_details: type: object description: An object that contains the shareable details of the order's payment source. example: foo: bar nullable: true token: type: string description: A unique token that can be shared more securely instead of the order's id. example: 1c0994cc4e996e8c6ee56a2198f66f3c nullable: true cart_url: type: string description: The cart url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/cart nullable: true return_url: type: string description: The return url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/ nullable: true terms_url: type: string description: The terms and conditions url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/terms nullable: true privacy_url: type: string description: The privacy policy url on your site. If present, it will be used on our hosted checkout application. example: https://yourdomain.com/privacy nullable: true checkout_url: type: string description: The checkout url that was automatically generated for the order. Send the customers to this url to let them checkout the order securely on our hosted checkout application. example: https://yourdomain.commercelayer.io/checkout/1c0994cc4e996e8c6ee56a2198f66f3c nullable: true placed_at: type: string description: Time at which the order was placed. example: '2018-01-01T12:00:00.000Z' nullable: true approved_at: type: string description: Time at which the order was approved. example: '2018-01-01T12:00:00.000Z' nullable: true cancelled_at: type: string description: Time at which the order was cancelled. example: '2018-01-01T12:00:00.000Z' nullable: true payment_updated_at: type: string description: Time at which the order's payment status was last updated. example: '2018-01-01T12:00:00.000Z' nullable: true fulfillment_updated_at: type: string description: Time at which the order's fulfillment status was last updated. example: '2018-01-01T12:00:00.000Z' nullable: true refreshed_at: type: string description: Last time at which the order was refreshed. example: '2018-01-01T12:00:00.000Z' nullable: true archived_at: type: string description: Time at which the resource has been archived. example: '2018-01-01T12:00:00.000Z' nullable: true subscription_created_at: type: string description: Time at which the order has been marked to create a subscription from its recurring line items. example: '2018-01-01T12:00:00.000Z' nullable: true expires_at: type: string description: The expiration date/time of this order. Cannot be passed by sales channels. example: '2018-01-02T12:00:00.000Z' nullable: true expiration_info: type: object description: The information related to the order expiration, in case expires_at is not null. Cannot be passed by sales channels. example: summary_message: Your tickets are reserved for the remaining time. expired_message: Your session has expired. Please start your checkout again. redirect_url: https://yourshop.com/ 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 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: market: 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 customer: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN shipping_address: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - addresses id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN billing_address: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - addresses id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN store: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - stores id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN default_shipping_method: 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: 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 available_payment_methods: 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 available_customer_payment_sources: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customer_payment_sources id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN available_free_skus: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - skus id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN available_free_bundles: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - bundles id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_method: 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 payment_source: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - adyen_payments - axerve_payments - braintree_payments - checkout_com_payments - external_payments - klarna_payments - paypal_payments - satispay_payments - stripe_payments - wire_transfers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/adyenPayment' - $ref: '#/components/schemas/axervePayment' - $ref: '#/components/schemas/braintreePayment' - $ref: '#/components/schemas/checkoutComPayment' - $ref: '#/components/schemas/externalPayment' - $ref: '#/components/schemas/klarnaPayment' - $ref: '#/components/schemas/paypalPayment' - $ref: '#/components/schemas/satispayPayment' - $ref: '#/components/schemas/stripePayment' - $ref: '#/components/schemas/wireTransfer' discount_engine_item: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - discount_engine_items id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN line_items: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - line_items id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN line_item_options: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - line_item_options id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN stock_reservations: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - stock_reservations id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN stock_line_items: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - stock_line_items id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN stock_transfers: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - stock_transfers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN shipments: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - shipments id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_options: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_options id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN transactions: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - authorizations - voids - captures - refunds id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/authorization' - $ref: '#/components/schemas/void' - $ref: '#/components/schemas/capture' - $ref: '#/components/schemas/refund' authorizations: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - authorizations id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN captures: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - captures id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN voids: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - voids id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN refunds: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - refunds id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN returns: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - returns id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN order_subscription: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - order_subscriptions id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN order_subscriptions: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - order_subscriptions id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN order_factories: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - order_factories id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN order_copies: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - order_copies id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN recurring_order_copies: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - recurring_order_copies 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 notifications: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - notifications id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN links: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - links id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN resource_errors: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - resource_errors 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 tags: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tags 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 paypalPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - paypal_payments attributes: type: object properties: return_url: type: string description: The URL where the payer is redirected after they approve the payment. example: https://yourdomain.com/thankyou nullable: false cancel_url: type: string description: The URL where the payer is redirected after they cancel the payment. example: https://yourdomain.com/checkout/payment nullable: false note_to_payer: type: string description: A free-form field that you can use to send a note to the payer on PayPal. example: Thank you for shopping with us! nullable: true paypal_payer_id: type: string description: The id of the payer that PayPal passes in the return_url. example: ABCDEFGHG123456 nullable: true name: type: string description: The PayPal payer id (if present). example: ABCDEFGHG123456 nullable: true paypal_id: type: string description: The id of the PayPal payment object. example: '1234567890' nullable: true status: type: string description: The PayPal payment status. One of 'created', or 'approved'. example: created nullable: true enum: - created - approved approval_url: type: string description: The URL the customer should be redirected to approve the payment. example: https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-1234567890ABCDEFGHG nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the created payment intent. example: false nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways 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 refund: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - refunds attributes: type: object properties: number: type: string description: The transaction number, auto generated. example: 42/T/001 nullable: false type: type: string description: The transaction's type. example: authorizations nullable: false enum: - authorizations - voids - captures - refunds payment_method_type: type: string description: Information about the payment method used in the transaction. example: credit card nullable: true currency_code: type: string description: The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order. example: EUR nullable: false amount_cents: type: integer description: The transaction amount, in cents. example: 1500 nullable: false amount_float: type: number description: The transaction amount, float. example: 15.0 nullable: false formatted_amount: type: string description: The transaction amount, formatted. example: €15,00 nullable: false succeeded: type: boolean description: Indicates if the transaction is successful. example: false nullable: false message: type: string description: The message returned by the payment gateway. example: Accepted nullable: true error_code: type: string description: The error code, if any, returned by the payment gateway. example: '00001' nullable: true error_detail: type: string description: The error detail, if any, returned by the payment gateway. example: Already settled nullable: true token: type: string description: The token identifying the transaction, returned by the payment gateway. example: xxxx-yyyy-zzzz nullable: true gateway_transaction_id: type: string description: The ID identifying the transaction, returned by the payment gateway. example: xxxx-yyyy-zzzz nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_source: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - adyen_payments - axerve_payments - braintree_payments - checkout_com_payments - external_payments - klarna_payments - paypal_payments - satispay_payments - stripe_payments - wire_transfers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/adyenPayment' - $ref: '#/components/schemas/axervePayment' - $ref: '#/components/schemas/braintreePayment' - $ref: '#/components/schemas/checkoutComPayment' - $ref: '#/components/schemas/externalPayment' - $ref: '#/components/schemas/klarnaPayment' - $ref: '#/components/schemas/paypalPayment' - $ref: '#/components/schemas/satispayPayment' - $ref: '#/components/schemas/stripePayment' - $ref: '#/components/schemas/wireTransfer' 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 reference_capture: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - captures id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN return: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - returns id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN link: properties: data: properties: attributes: type: object properties: name: type: string description: The link internal name. example: FW SALE 2023 nullable: false client_id: type: string description: The link application client id, used to fetch JWT. example: xxxx-yyyy-zzzz nullable: false scope: type: string description: The link application scope, used to fetch JWT. example: market:id:GhvCxsElAQ,market:id:kJhgVcxZDr nullable: false starts_at: type: string description: The activation date/time of this link. example: '2018-01-01T12:00:00.000Z' nullable: true expires_at: type: string description: The expiration date/time of this link (must be after starts_at). example: '2018-01-02T12:00:00.000Z' nullable: true active: type: boolean description: Indicates if the link is active (enabled and not expired). example: true nullable: true status: type: string description: The link status. One of 'disabled', 'expired', 'pending', or 'active'. example: pending nullable: true enum: - disabled - expired - pending - active domain: type: string description: The link URL second level domain. example: commercelayer.link nullable: true url: type: string description: The link URL. example: https://commercelayer.link/ZXUtd2VzdC0xLzE5ZjBlMGVlLTg4OGMtNDQ1Yi1iYTA0LTg3MTUxY2FjZjFmYQ nullable: true item_type: type: string description: The type of the associated item. One of 'orders', 'skus', or 'sku_lists'. example: orders nullable: true enum: - orders - skus - sku_lists params: type: object description: The link params to be passed in URL the query string. example: param1: ABC param2: XYZ nullable: true disabled_at: type: string description: Time at which this resource was disabled. example: '2018-01-01T12:00:00.000Z' nullable: true 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 authorization: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - authorizations attributes: type: object properties: number: type: string description: The transaction number, auto generated. example: 42/T/001 nullable: false type: type: string description: The transaction's type. example: authorizations nullable: false enum: - authorizations - voids - captures - refunds payment_method_type: type: string description: Information about the payment method used in the transaction. example: credit card nullable: true currency_code: type: string description: The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order. example: EUR nullable: false amount_cents: type: integer description: The transaction amount, in cents. example: 1500 nullable: false amount_float: type: number description: The transaction amount, float. example: 15.0 nullable: false formatted_amount: type: string description: The transaction amount, formatted. example: €15,00 nullable: false succeeded: type: boolean description: Indicates if the transaction is successful. example: false nullable: false message: type: string description: The message returned by the payment gateway. example: Accepted nullable: true error_code: type: string description: The error code, if any, returned by the payment gateway. example: '00001' nullable: true error_detail: type: string description: The error detail, if any, returned by the payment gateway. example: Already settled nullable: true token: type: string description: The token identifying the transaction, returned by the payment gateway. example: xxxx-yyyy-zzzz nullable: true gateway_transaction_id: type: string description: The ID identifying the transaction, returned by the payment gateway. example: xxxx-yyyy-zzzz nullable: true 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 cvv_code: type: string description: The CVV code returned by the payment gateway. example: '000' nullable: true cvv_message: type: string description: The CVV message returned by the payment gateway. example: validated nullable: true avs_code: type: string description: The AVS code returned by the payment gateway. example: '000' nullable: true avs_message: type: string description: The AVS message returned by the payment gateway. example: validated nullable: true fraud_review: type: string description: The fraud review message, if any, returned by the payment gateway. example: passed nullable: true capture_amount_cents: type: integer description: The amount to be captured, in cents. example: 500 nullable: true capture_amount_float: type: number description: The amount to be captured, float. example: 5.0 nullable: true formatted_capture_amount: type: string description: The amount to be captured, formatted. example: €5,00 nullable: true capture_balance_cents: type: integer description: The balance to be captured, in cents. example: 1000 nullable: true capture_balance_float: type: number description: The balance to be captured, float. example: 10.0 nullable: true formatted_capture_balance: type: string description: The balance to be captured, formatted. example: €10,00 nullable: true void_balance_cents: type: integer description: The balance to be voided, in cents. example: 1500 nullable: true void_balance_float: type: number description: The balance to be voided, float. example: 15.0 nullable: true formatted_void_balance: type: string description: The balance to be voided, formatted. example: €15,00 nullable: true relationships: type: object properties: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_source: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - adyen_payments - axerve_payments - braintree_payments - checkout_com_payments - external_payments - klarna_payments - paypal_payments - satispay_payments - stripe_payments - wire_transfers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/adyenPayment' - $ref: '#/components/schemas/axervePayment' - $ref: '#/components/schemas/braintreePayment' - $ref: '#/components/schemas/checkoutComPayment' - $ref: '#/components/schemas/externalPayment' - $ref: '#/components/schemas/klarnaPayment' - $ref: '#/components/schemas/paypalPayment' - $ref: '#/components/schemas/satispayPayment' - $ref: '#/components/schemas/stripePayment' - $ref: '#/components/schemas/wireTransfer' 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 captures: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - captures id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN voids: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - voids id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN linkUpdate: required: - data type: object properties: data: type: object required: - type - id - attributes properties: type: type: string description: The resource's type enum: - links id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN attributes: type: object properties: name: type: string description: The link internal name. example: FW SALE 2023 nullable: false client_id: type: string description: The link application client id, used to fetch JWT. example: xxxx-yyyy-zzzz nullable: false scope: type: string description: The link application scope, used to fetch JWT. example: market:id:GhvCxsElAQ,market:id:kJhgVcxZDr nullable: false starts_at: type: string description: The activation date/time of this link. example: '2018-01-01T12:00:00.000Z' nullable: true expires_at: type: string description: The expiration date/time of this link (must be after starts_at). example: '2018-01-02T12:00:00.000Z' nullable: true domain: type: string description: The link URL second level domain. example: commercelayer.link nullable: true params: type: object description: The link params to be passed in URL the query string. example: param1: ABC param2: XYZ 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 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: item: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders - skus - sku_lists id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/order' - $ref: '#/components/schemas/sku' - $ref: '#/components/schemas/skuList' checkoutComPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - checkout_com_payments attributes: type: object properties: public_key: type: string description: The Checkout.com publishable API key. example: pk_test_xxxx-yyyy-zzzz nullable: true token: type: string description: The Checkout.com payment or digital wallet token. example: tok_4gzeau5o2uqubbk6fufs3m7p54 nullable: false payment_session: type: object description: The session object which initializes payment. example: id: ps_xxxx_yyyy_zzzz payment_session_secret: pss_xxxx_yyy_zzzz payment_session_token: xxxxx_yyyyy_zzzzz _links: self: href: https://api.sandbox.checkout.com/payment-sessions/ps_xxxx_yyyy_zzzz nullable: false success_url: type: string description: The URL to redirect your customer upon 3DS succeeded authentication. example: http://commercelayer.dev/checkout_com/success nullable: false failure_url: type: string description: The URL to redirect your customer upon 3DS failed authentication. example: http://commercelayer.dev/checkout_com/failure nullable: false source_id: type: string description: The payment source identifier that can be used for subsequent payments. example: src_nwd3m4in3hkuddfpjsaevunhdy nullable: true customer_token: type: string description: The customer's unique identifier. This can be passed as a source when making a payment. example: cus_udst2tfldj6upmye2reztkmm4i nullable: true redirect_uri: type: string description: The URI that the customer should be redirected to in order to complete the payment. example: https://api.checkout.com/3ds/pay_mbabizu24mvu3mela5njyhpit4 nullable: true payment_response: type: object description: The Checkout.com payment response, used to fetch internal data. example: foo: bar nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the associated authorization. example: false nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways 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 adyenPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - adyen_payments attributes: type: object properties: public_key: type: string description: The public key linked to your API credential. example: xxxx-yyyy-zzzz nullable: true payment_methods: type: object description: The merchant available payment methods for the assoiated order (i.e. country and amount). Required by the Adyen JS SDK. example: foo: bar nullable: false payment_request_data: type: object description: The Adyen payment request data, collected by client. example: foo: bar nullable: true payment_request_details: type: object description: The Adyen additional details request data, collected by client. example: foo: bar nullable: true payment_response: type: object description: The Adyen payment response, used by client (includes 'resultCode' and 'action'). example: foo: bar nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the associated authorization. example: false nullable: true balance: type: integer description: The balance remaining on a shopper's gift card, must be computed by using its related trigger attribute. example: 1000 nullable: true expires_at: type: string description: The expiration date/time of this Adyen payment (valid for partial payments only). example: '2018-01-02T12:00:00.000Z' nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways 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 sku: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - skus attributes: type: object properties: code: type: string description: The SKU code, that uniquely identifies the SKU within the organization. example: TSHIRTMM000000FFFFFFXLXX nullable: false name: type: string description: The internal name of the SKU. example: Men's Black T-shirt with White Logo (XL) nullable: false description: type: string description: An internal description of the SKU. example: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. nullable: true image_url: type: string description: The URL of an image that represents the SKU. example: https://img.yourdomain.com/skus/xYZkjABcde.png nullable: true pieces_per_pack: type: integer description: The number of pieces that compose the SKU. This is useful to describe sets and bundles. example: 6 nullable: true weight: type: number description: The weight of the SKU. If present, it will be used to calculate the shipping rates. example: 300.0 nullable: true unit_of_weight: type: string description: The unit of weight. One of 'gr', 'oz', or 'lb'. example: gr nullable: true enum: - gr - oz - lb hs_tariff_number: type: string description: The Harmonized System Code used by customs to identify the products shipped across international borders. example: 4901.91.0020 nullable: true do_not_ship: type: boolean description: Indicates if the SKU doesn't generate shipments. example: false nullable: true do_not_track: type: boolean description: Indicates if the SKU doesn't track the stock inventory. example: false nullable: true inventory: type: object description: Aggregated information about the SKU's inventory. Returned only when retrieving a single SKU. example: available: true quantity: 10 levels: - quantity: 4 delivery_lead_times: - shipping_method: name: Standard Shipping reference: null price_amount_cents: 700 free_over_amount_cents: 9900 formatted_price_amount: €7,00 formatted_free_over_amount: €99,00 min: hours: 72 days: 3 max: hours: 120 days: 5 - shipping_method: name: Express Delivery reference: null price_amount_cents: 1200 free_over_amount_cents: null formatted_price_amount: €12,00 formatted_free_over_amount: null min: hours: 48 days: 2 max: hours: 72 days: 3 - quantity: 6 delivery_lead_times: - shipping_method: name: Standard Shipping reference: null price_amount_cents: 700 free_over_amount_cents: 9900 formatted_price_amount: €7,00 formatted_free_over_amount: €99,00 min: hours: 96 days: 4 max: hours: 144 days: 6 - shipping_method: name: Express Delivery reference: null price_amount_cents: 1200 free_over_amount_cents: null formatted_price_amount: €12,00 formatted_free_over_amount: null min: hours: 72 days: 3 max: hours: 96 days: 4 nullable: true 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 jwt_custom_claim: type: object description: The custom_claim attached to the current JWT (if any). example: {} 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: shipping_category: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - shipping_categories id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN prices: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - prices id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN stock_items: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - stock_items id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN stock_reservations: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - stock_reservations id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN delivery_lead_times: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - delivery_lead_times id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN sku_options: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - sku_options id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN sku_list_items: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - sku_list_items id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN sku_lists: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - sku_lists 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 links: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - links 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 tags: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - tags id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN jwt_customer: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN jwt_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 jwt_stock_locations: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - stock_locations 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 linkCreate: required: - data type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - links attributes: type: object properties: name: type: string description: The link internal name. example: FW SALE 2023 client_id: type: string description: The link application client id, used to fetch JWT. example: xxxx-yyyy-zzzz scope: type: string description: The link application scope, used to fetch JWT. example: market:id:GhvCxsElAQ,market:id:kJhgVcxZDr starts_at: type: string description: The activation date/time of this link. example: '2018-01-01T12:00:00.000Z' expires_at: type: string description: The expiration date/time of this link (must be after starts_at). example: '2018-01-02T12:00:00.000Z' domain: type: string description: The link URL second level domain. example: commercelayer.link item_type: type: string description: The type of the associated item. One of 'orders', 'skus', or 'sku_lists'. example: orders enum: - orders - skus - sku_lists params: type: object description: The link params to be passed in URL the query string. example: param1: ABC param2: XYZ _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 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 - client_id - scope relationships: type: object properties: item: required: - data type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders - skus - sku_lists id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/order' - $ref: '#/components/schemas/sku' - $ref: '#/components/schemas/skuList' required: - item stripePayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - stripe_payments attributes: type: object properties: stripe_id: type: string description: The Stripe payment intent ID. Required to identify a payment session on stripe. example: pi_1234XXX nullable: true client_secret: type: string description: The Stripe payment intent client secret. Required to create a charge through Stripe.js. example: pi_1234XXX_secret_5678YYY nullable: true connected_account: type: string description: The account (if any) for which the funds of the PaymentIntent are intended. example: acct_xxxx-yyyy-zzzz nullable: true charge_id: type: string description: The Stripe charge ID. Identifies money movement upon the payment intent confirmation. example: ch_1234XXX nullable: true publishable_key: type: string description: The Stripe publishable API key. example: pk_live_xxxx-yyyy-zzzz nullable: true on_behalf_of: type: string description: The Stripe account ID that these funds are intended for. example: xxxx-yyyy-zzzz nullable: true transfer_group: type: string description: A string that identifies the resulting payment as part of a group. example: xxxx-yyyy-zzzz nullable: true options: type: object description: 'Stripe payment options: ''customer'', ''payment_method'', ''return_url'', etc. Check Stripe payment intent API for more details.' example: customer: cus_xxx payment_method: pm_xxx nullable: true payment_method: type: object description: Stripe 'payment_method', set by webhook. example: id: pm_xxx nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the created payment intent. example: false nullable: true return_url: type: string description: The URL to return to when a redirect payment is completed. example: https://yourdomain.com/thankyou nullable: true receipt_email: type: string description: The email address to send the receipt to. example: john@example.com nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways 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 linkResponse: 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: - links links: type: object properties: self: type: string description: URL attributes: $ref: '#/components/schemas/link/properties/data/properties/attributes' relationships: type: object properties: item: 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: - item id: type: string description: The resource ID events: 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: - events 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 void: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - voids attributes: type: object properties: number: type: string description: The transaction number, auto generated. example: 42/T/001 nullable: false type: type: string description: The transaction's type. example: authorizations nullable: false enum: - authorizations - voids - captures - refunds payment_method_type: type: string description: Information about the payment method used in the transaction. example: credit card nullable: true currency_code: type: string description: The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order. example: EUR nullable: false amount_cents: type: integer description: The transaction amount, in cents. example: 1500 nullable: false amount_float: type: number description: The transaction amount, float. example: 15.0 nullable: false formatted_amount: type: string description: The transaction amount, formatted. example: €15,00 nullable: false succeeded: type: boolean description: Indicates if the transaction is successful. example: false nullable: false message: type: string description: The message returned by the payment gateway. example: Accepted nullable: true error_code: type: string description: The error code, if any, returned by the payment gateway. example: '00001' nullable: true error_detail: type: string description: The error detail, if any, returned by the payment gateway. example: Already settled nullable: true token: type: string description: The token identifying the transaction, returned by the payment gateway. example: xxxx-yyyy-zzzz nullable: true gateway_transaction_id: type: string description: The ID identifying the transaction, returned by the payment gateway. example: xxxx-yyyy-zzzz nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_source: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - adyen_payments - axerve_payments - braintree_payments - checkout_com_payments - external_payments - klarna_payments - paypal_payments - satispay_payments - stripe_payments - wire_transfers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN oneOf: - $ref: '#/components/schemas/adyenPayment' - $ref: '#/components/schemas/axervePayment' - $ref: '#/components/schemas/braintreePayment' - $ref: '#/components/schemas/checkoutComPayment' - $ref: '#/components/schemas/externalPayment' - $ref: '#/components/schemas/klarnaPayment' - $ref: '#/components/schemas/paypalPayment' - $ref: '#/components/schemas/satispayPayment' - $ref: '#/components/schemas/stripePayment' - $ref: '#/components/schemas/wireTransfer' 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 reference_authorization: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - authorizations id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN klarnaPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - klarna_payments attributes: type: object properties: session_id: type: string description: The identifier of the payment session. example: xxxx-yyyy-zzzz nullable: true client_token: type: string description: The public token linked to your API credential. Available upon session creation. example: xxxx-yyyy-zzzz nullable: true payment_methods: type: array description: The merchant available payment methods for the assoiated order. Available upon session creation. example: - foo: bar nullable: false items: type: object auth_token: type: string description: The token returned by a successful client authorization, mandatory to place the order. example: xxxx-yyyy-zzzz nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the created payment intent. example: false nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways 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 externalPayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - external_payments attributes: type: object properties: payment_source_token: type: string description: The payment source token, as generated by the external gateway SDK. Credit Card numbers are rejected. example: xxxx.yyyy.zzzz nullable: false options: type: object description: External payment options. example: foo: bar nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN wallet: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customer_payment_sources 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 axervePayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - axerve_payments attributes: type: object properties: login: type: string description: The merchant login code. example: xxxx-yyyy-zzzz nullable: false return_url: type: string description: The URL where the payer is redirected after they approve the payment. example: https://yourdomain.com/thankyou nullable: false payment_request_data: type: object description: The Axerve payment request data, collected by client. example: foo: bar nullable: true client_ip: type: string description: The IP adress of the client creating the payment. example: 213.45.120.5 nullable: true buyer_details: type: object description: The details of the buyer creating the payment. example: cardHolder: email: george.harrison@gmail.com shippingAddress: firstName: George nullable: true request_token: type: boolean description: Requires the creation of a token to represent this payment, mandatory to use customer's wallet and order subscriptions. example: true nullable: true mismatched_amounts: type: boolean description: Indicates if the order current amount differs form the one of the associated authorization. example: false nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways 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 braintreePayment: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - braintree_payments attributes: type: object properties: client_token: type: string description: The Braintree payment client token. Required by the Braintree JS SDK. example: xxxx.yyyy.zzzz nullable: false payment_method_nonce: type: string description: The Braintree payment method nonce. Sent by the Braintree JS SDK. example: xxxx.yyyy.zzzz nullable: true payment_id: type: string description: The Braintree payment ID used by local payment and sent by the Braintree JS SDK. example: xxxx.yyyy.zzzz nullable: true local: type: boolean description: Indicates if the payment is local, in such case Braintree will trigger a webhook call passing the "payment_id" and "payment_method_nonce" in order to complete the transaction. example: true nullable: true options: type: object description: Braintree payment options, 'customer_id' and 'payment_method_token'. example: customer_id: '1234567890' nullable: true payment_instrument: type: object description: Information about the payment instrument used in the transaction. example: issuer: cl bank card_type: visa nullable: true 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: order: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - orders id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN payment_gateway: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - payment_gateways 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 skuList: type: object properties: data: type: object required: - type - attributes properties: type: type: string description: The resource's type enum: - sku_lists attributes: type: object properties: name: type: string description: The SKU list's internal name. example: Personal list nullable: false slug: type: string description: The SKU list's internal slug. example: personal-list-1 nullable: false description: type: string description: An internal description of the SKU list. example: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. nullable: true image_url: type: string description: The URL of an image that represents the SKU list. example: https://img.yourdomain.com/skus/xYZkjABcde.png nullable: true manual: type: boolean description: Indicates if the SKU list is populated manually. example: false nullable: true sku_code_regex: type: string description: The regex that will be evaluated to match the SKU codes, max size is 5000. example: ^(A|B).*$ nullable: true 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: customer: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - customers id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN skus: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - skus id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN sku_list_items: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - sku_list_items id: type: string description: Unique identifier for the resource (hash). example: XAyRWNUzyN bundles: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - bundles 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 links: type: object properties: data: type: object properties: type: type: string description: The resource's type enum: - links 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 linkResponseList: type: object properties: data: type: array items: $ref: '#/components/schemas/linkResponse/properties/data' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT