{ "opencollection": "1.0.0", "info": { "name": "Ankorstore Stock Tracking and Logistics Applications OrderPay API", "version": "1.2.2-oas3.1" }, "items": [ { "info": { "name": "OrderPay", "type": "folder" }, "items": [ { "info": { "name": "List customers", "type": "http" }, "http": { "method": "GET", "url": "http://www.ankorlocal.com:8000/api/v1/order-pay/order-pay-customer", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "filter[storeName]", "value": "", "type": "query" }, { "name": "filter[email]", "value": "", "type": "query" }, { "name": "page[number]", "value": "", "type": "query", "description": "Page number, starting at 1" }, { "name": "page[size]", "value": "", "type": "query", "description": "Maximum number of elements per page" }, { "name": "sort", "value": "", "type": "query", "description": "Comma-separated list of attributes to sort by (storeName by default)" }, { "name": "include", "value": "", "type": "query", "description": "A comma-separated list of resources to include (e.g: paymentMethods)" } ] }, "docs": "Retrieves a list of customers associated with an OrderPay account. The result is paginated. Furthermore a filter can be applied on the result.\n" }, { "info": { "name": "Create a customer", "type": "http" }, "http": { "method": "POST", "url": "http://www.ankorlocal.com:8000/api/v1/order-pay/order-pay-customer", "headers": [ { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new OrderPay customer." }, { "info": { "name": "Retrieve a single customer", "type": "http" }, "http": { "method": "GET", "url": "http://www.ankorlocal.com:8000/api/v1/order-pay/order-pay-customer/:order_pay_customer", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "order_pay_customer", "value": "", "type": "path", "description": "Customer ID" }, { "name": "include", "value": "", "type": "query", "description": "A comma-separated list of resources to include" } ] }, "docs": "Retrieves details for a single customer." }, { "info": { "name": "Update a customer profile", "type": "http" }, "http": { "method": "PATCH", "url": "http://www.ankorlocal.com:8000/api/v1/order-pay/order-pay-customer/:order_pay_customer", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "order_pay_customer", "value": "", "type": "path", "description": "Customer ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a customer profile." }, { "info": { "name": "Create a new order", "type": "http" }, "http": { "method": "POST", "url": "http://www.ankorlocal.com:8000/api/v1/order-pay/order-pay-orders", "headers": [ { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new OrderPay order." }, { "info": { "name": "Retrieve an order", "type": "http" }, "http": { "method": "GET", "url": "http://www.ankorlocal.com:8000/api/v1/order-pay/order-pay-orders/:id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "UUID of the requested resource" }, { "name": "include", "value": "", "type": "query", "description": "A comma-separated list of resources to include (e.g: payment,payment.transactions)" } ] }, "docs": "Retrieves an OrderPay order by ID." }, { "info": { "name": "Update an order", "type": "http" }, "http": { "method": "PATCH", "url": "http://www.ankorlocal.com:8000/api/v1/order-pay/order-pay-orders/:id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "UUID of the requested resource" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing OrderPay order." }, { "info": { "name": "Cancel an order", "type": "http" }, "http": { "method": "POST", "url": "http://www.ankorlocal.com:8000/api/v1/order-pay/order-pay-orders/:id/-actions/cancel", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "UUID of the requested resource" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows brand to cancel an order" }, { "info": { "name": "Confirm an order", "type": "http" }, "http": { "method": "POST", "url": "http://www.ankorlocal.com:8000/api/v1/order-pay/order-pay-orders/:id/-actions/confirm", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "UUID of the requested resource" } ] }, "docs": "Allows brand to confirm order." } ] } ], "bundled": true }