{
  "opencollection": "1.0.0",
  "info": {
    "name": "Commerce Layer addresses orders API",
    "version": "7.10.1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "orders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve the order associated to the adyen payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/adyen_payments/:adyenPaymentId/order",
            "params": [
              {
                "name": "adyenPaymentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the adyen payment"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the authorization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/authorizations/:authorizationId/order",
            "params": [
              {
                "name": "authorizationId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the authorization"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the axerve payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/axerve_payments/:axervePaymentId/order",
            "params": [
              {
                "name": "axervePaymentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the axerve payment"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the braintree payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/braintree_payments/:braintreePaymentId/order",
            "params": [
              {
                "name": "braintreePaymentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the braintree payment"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the capture",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/captures/:captureId/order",
            "params": [
              {
                "name": "captureId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the capture"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the checkout.com payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/checkout_com_payments/:checkoutComPaymentId/order",
            "params": [
              {
                "name": "checkoutComPaymentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the checkout.com payment"
        },
        {
          "info": {
            "name": "Retrieve the orders associated to the customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/customers/:customerId/orders",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the orders associated to the customer"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the discount engine item",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/discount_engine_items/:discountEngineItemId/order",
            "params": [
              {
                "name": "discountEngineItemId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the discount engine item"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the external payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/external_payments/:externalPaymentId/order",
            "params": [
              {
                "name": "externalPaymentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the external payment"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the klarna payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/klarna_payments/:klarnaPaymentId/order",
            "params": [
              {
                "name": "klarnaPaymentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the klarna payment"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the line item",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/line_items/:lineItemId/order",
            "params": [
              {
                "name": "lineItemId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the line item"
        },
        {
          "info": {
            "name": "Retrieve the source order associated to the order copy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/order_copies/:orderCopyId/source_order",
            "params": [
              {
                "name": "orderCopyId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the source order associated to the order copy"
        },
        {
          "info": {
            "name": "Retrieve the target order associated to the order copy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/order_copies/:orderCopyId/target_order",
            "params": [
              {
                "name": "orderCopyId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the target order associated to the order copy"
        },
        {
          "info": {
            "name": "Retrieve the source order associated to the order factory",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/order_factories/:orderFactoryId/source_order",
            "params": [
              {
                "name": "orderFactoryId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the source order associated to the order factory"
        },
        {
          "info": {
            "name": "Retrieve the target order associated to the order factory",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/order_factories/:orderFactoryId/target_order",
            "params": [
              {
                "name": "orderFactoryId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the target order associated to the order factory"
        },
        {
          "info": {
            "name": "Retrieve the source order associated to the order subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/order_subscriptions/:orderSubscriptionId/source_order",
            "params": [
              {
                "name": "orderSubscriptionId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the source order associated to the order subscription"
        },
        {
          "info": {
            "name": "Retrieve the orders associated to the order subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/order_subscriptions/:orderSubscriptionId/orders",
            "params": [
              {
                "name": "orderSubscriptionId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the orders associated to the order subscription"
        },
        {
          "info": {
            "name": "List all orders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders"
          },
          "docs": "List all orders"
        },
        {
          "info": {
            "name": "Create an order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an order"
        },
        {
          "info": {
            "name": "Retrieve an order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders/:orderId",
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve an order"
        },
        {
          "info": {
            "name": "Update an order",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders/:orderId",
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an order"
        },
        {
          "info": {
            "name": "Delete an order",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders/:orderId",
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Delete an order"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the payment option",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/payment_options/:paymentOptionId/order",
            "params": [
              {
                "name": "paymentOptionId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the payment option"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the paypal payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/paypal_payments/:paypalPaymentId/order",
            "params": [
              {
                "name": "paypalPaymentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the paypal payment"
        },
        {
          "info": {
            "name": "Retrieve the source order associated to the recurring order copy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/recurring_order_copies/:recurringOrderCopyId/source_order",
            "params": [
              {
                "name": "recurringOrderCopyId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the source order associated to the recurring order copy"
        },
        {
          "info": {
            "name": "Retrieve the target order associated to the recurring order copy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/recurring_order_copies/:recurringOrderCopyId/target_order",
            "params": [
              {
                "name": "recurringOrderCopyId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the target order associated to the recurring order copy"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the refund",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/refunds/:refundId/order",
            "params": [
              {
                "name": "refundId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the refund"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the return",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/returns/:returnId/order",
            "params": [
              {
                "name": "returnId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the return"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the satispay payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/satispay_payments/:satispayPaymentId/order",
            "params": [
              {
                "name": "satispayPaymentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the satispay payment"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the shipment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/shipments/:shipmentId/order",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the shipment"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the stock reservation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/stock_reservations/:stockReservationId/order",
            "params": [
              {
                "name": "stockReservationId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the stock reservation"
        },
        {
          "info": {
            "name": "Retrieve the orders associated to the store",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/stores/:storeId/orders",
            "params": [
              {
                "name": "storeId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the orders associated to the store"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the stripe payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/stripe_payments/:stripePaymentId/order",
            "params": [
              {
                "name": "stripePaymentId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the stripe payment"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the transaction",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/transactions/:transactionId/order",
            "params": [
              {
                "name": "transactionId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the transaction"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the void",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/voids/:voidId/order",
            "params": [
              {
                "name": "voidId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the void"
        },
        {
          "info": {
            "name": "Retrieve the order associated to the wire transfer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{your_organization_slug}.commercelayer.io/api/wire_transfers/:wireTransferId/order",
            "params": [
              {
                "name": "wireTransferId",
                "value": "",
                "type": "path",
                "description": "The resource's id"
              }
            ]
          },
          "docs": "Retrieve the order associated to the wire transfer"
        },
        {
          "info": {
            "name": "Query breakdown on orders",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders/breakdown",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Breakdowns are aggregations that summarize your data as metrics (based on specific operators) or statistics, computed on field values. When performing a breakdown query on the Metrics API endpoint you get in the response the value of the computation (based on the selected operator) on the selected field, aggregated by another field.\r\n\r\n### Nesting breakdowns\r\nBreakdowns can be nested recursively one into the other, up to one level (see example). The valid values allowed for the by key of the nes"
        },
        {
          "info": {
            "name": "Query date_breakdown on orders",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders/date_breakdown",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Date breakdowns summarizes metrics data grouped by time intervals on a defined time range. They also support support breakdowns over the main date breakdown query and also supports all breakdown queries capabilities through the \"breakdown\" key, this also includes the possibility of nesting the breakdown over the main breakdown. \r\n\r\n\r\nSingle date breakdown request (no breakdown)\r\n\r\n`{\r\n\t\"date_breakdown\": {\r\n            \"by\": \"shipments.cancelled_at\",\r\n            \"field\": \"order.id\",\r\n           "
        },
        {
          "info": {
            "name": "Query stats on orders",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders/stats",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Stats are aggregations that summarize your data within an operator (depending of the field, some of them could not be available), such as: value_count, cardinality, avg, min, max, sum or stats (which returns avg, min, max, sum) computed on the field specificed. When performing a stats query on the Metrics API endpoint you get in the response the value of the computation (based on the selected operator) on the selected field.\r\n\r\nStats request\r\n\r\n`{\r\n\t \"stats\": {\r\n        \"field\": \"order.total_amo"
        },
        {
          "info": {
            "name": "Query search on orders",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get search results from orders"
        },
        {
          "info": {
            "name": "Query export on orders",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{your_organization_slug}.commercelayer.io/api/orders/export",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get export results from orders"
        }
      ]
    }
  ],
  "bundled": true
}