{
  "opencollection": "1.0.0",
  "info": {
    "name": "VirtoCommerce.Cart Catalog Order Management API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Order Management",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search customer orders by given criteria",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/customerOrders/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Search customer orders by given criteria"
        },
        {
          "info": {
            "name": "Find customer order by number",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/customerOrders/number/:number",
            "params": [
              {
                "name": "number",
                "value": "",
                "type": "path",
                "description": "customer order number"
              },
              {
                "name": "respGroup",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return a single customer order with all nested documents or null if order was not found"
        },
        {
          "info": {
            "name": "Find customer order by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/customerOrders/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "customer order id"
              },
              {
                "name": "respGroup",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return a single customer order with all nested documents or null if order was not found"
        },
        {
          "info": {
            "name": "Partial update for the specified Orde by id",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/order/customerOrders/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Orde id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Partial update for the specified Orde by id"
        },
        {
          "info": {
            "name": "Find customer order by outer id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/customerOrders/outer/:outerId",
            "params": [
              {
                "name": "outerId",
                "value": "",
                "type": "path",
                "description": "customer order outer id"
              },
              {
                "name": "responseGroup",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return a single customer order with all nested documents or null if order was not found"
        },
        {
          "info": {
            "name": "Calculate order totals after changes",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/order/customerOrders/recalculate",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return order with recalculated totals"
        },
        {
          "info": {
            "name": "Register customer order payment in external payment system",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/customerOrders/:orderId/processPayment/:paymentId",
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "customer order id"
              },
              {
                "name": "paymentId",
                "value": "",
                "type": "path",
                "description": "payment id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Used in storefront checkout or manual order payment registration"
        },
        {
          "info": {
            "name": "Create new customer order based on shopping cart.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/customerOrders/:cartId",
            "params": [
              {
                "name": "cartId",
                "value": "",
                "type": "path",
                "description": "shopping cart id"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create new customer order based on shopping cart."
        },
        {
          "info": {
            "name": "Add new customer order to system",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/customerOrders",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Add new customer order to system"
        },
        {
          "info": {
            "name": "Update a existing customer order",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/order/customerOrders",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update a existing customer order"
        },
        {
          "info": {
            "name": "Delete a whole customer orders",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/order/customerOrders",
            "params": [
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "customer order ids for delete"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Delete a whole customer orders"
        },
        {
          "info": {
            "name": "Get new shipment for specified customer order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/customerOrders/:id/shipments/new",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "customer order id"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return new shipment document with populates all required properties."
        },
        {
          "info": {
            "name": "Get new payment for specified customer order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/customerOrders/:id/payments/new",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "customer order id"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return new payment  document with populates all required properties."
        },
        {
          "info": {
            "name": "Get dashboard statistics settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/dashboardStatistics/settings",
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get dashboard statistics settings"
        },
        {
          "info": {
            "name": "Get a some order statistic information for Commerce manager dashboard",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/dashboardStatistics",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "start interval date"
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "end interval date"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get a some order statistic information for Commerce manager dashboard"
        },
        {
          "info": {
            "name": "Payment callback operation used by external payment services to inform post process payment in our system",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/paymentcallback",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Payment callback operation used by external payment services to inform post process payment in our system"
        },
        {
          "info": {
            "name": "Payment callback operation used by external payment services to inform post process payment in our system",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/paymentcallback-raw",
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Payment callback operation used by external payment services to inform post process payment in our system"
        },
        {
          "info": {
            "name": "Payment callback operation used by external payment services to inform post process payment in our system",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/paymentcallback-form",
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Payment callback operation used by external payment services to inform post process payment in our system"
        },
        {
          "info": {
            "name": "OrderModule_GetInvoicePdf",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/customerOrders/invoice/:orderNumber",
            "params": [
              {
                "name": "orderNumber",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          }
        },
        {
          "info": {
            "name": "OrderModule_GetOrderChanges",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/customerOrders/:id/changes",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          }
        },
        {
          "info": {
            "name": "OrderModule_SearchOrderChanges",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/customerOrders/searchChanges",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          }
        },
        {
          "info": {
            "name": "OrderModule_GetOrderFullTextSearchEnabled",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/customerOrders/indexed/searchEnabled",
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          }
        },
        {
          "info": {
            "name": "OrderModule_SearchCustomerOrderIndexed",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/customerOrders/indexed/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          }
        },
        {
          "info": {
            "name": "Search  order payments by given criteria",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/payments/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Search  order payments by given criteria"
        },
        {
          "info": {
            "name": "Find  order payment by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/payments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "order payment id"
              },
              {
                "name": "respGroup",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return a single order payment with all nested documents or null if payment was not found"
        },
        {
          "info": {
            "name": "Partial update for the specified Payment by id",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/order/payments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Payment id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Partial update for the specified Payment by id"
        },
        {
          "info": {
            "name": "Get order payment by outer id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/order/payments/outer/:outerId",
            "params": [
              {
                "name": "outerId",
                "value": "",
                "type": "path",
                "description": "order payment outer id"
              },
              {
                "name": "responseGroup",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return a single order payment with all nested documents or null if payment was not found"
        },
        {
          "info": {
            "name": "Create or update order payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/payments",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create or update order payment"
        },
        {
          "info": {
            "name": "OrderModulePayments_UpdatePayment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/order/payments",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          }
        },
        {
          "info": {
            "name": "Delete an order payment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/order/payments",
            "params": [
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "order payment ids"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Delete an order payment"
        },
        {
          "info": {
            "name": "OrderModulePayments_CapturePayment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/payments/payment/capture",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          }
        },
        {
          "info": {
            "name": "OrderModulePayments_RefundPayment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/payments/payment/refund",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          }
        },
        {
          "info": {
            "name": "OrderModuleShipments_UpdateShipment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/shipments",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          }
        },
        {
          "info": {
            "name": "Search shipments by given criteria",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/order/shipments/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Search shipments by given criteria"
        },
        {
          "info": {
            "name": "Partial update for the specified Shipment by id",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/order/shipments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Shipment id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Partial update for the specified Shipment by id"
        }
      ]
    }
  ],
  "bundled": true
}