{ "opencollection": "1.0.0", "info": { "name": "Public Account Pairing Endpoints Manager Order Endpoints API", "version": "v1" }, "items": [ { "info": { "name": "Manager Order Endpoints", "type": "folder" }, "items": [ { "info": { "name": "Otter Notify the Result of a Create Order Event", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/order/v1/orders/order-created", "headers": [ { "name": "X-Store-Id", "value": "" }, { "name": "X-Event-Id", "value": "" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 32 per minute`\n" }, { "info": { "name": "Otter Fetch Order Feed for a Store", "type": "http" }, "http": { "method": "GET", "url": "https://{public-api-url}/manager/order/v1/orders", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" }, { "name": "minDateTime", "value": "", "type": "query" }, { "name": "maxDateTime", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Otter Fetch Order Feed for a Store" }, { "info": { "name": "Otter Fetch Order with Manager Info", "type": "http" }, "http": { "method": "GET", "url": "https://{public-api-url}/manager/order/v1/sources/:source/orders/:orderId", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "orderId", "value": "", "type": "path" }, { "name": "source", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Otter Fetch Order with Manager Info" }, { "info": { "name": "Otter Request Order Confirmation", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/order/v1/sources/:source/orders/:orderId/confirm", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 32 per minute`\n" }, { "info": { "name": "Otter Request Order Cancelation", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/order/v1/sources/:source/orders/:orderId/cancel", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 32 per minute`\n" }, { "info": { "name": "Otter Mark an Order as Ready to Pickup", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/order/v1/sources/:source/orders/:orderId/ready-to-pickup", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 32 per minute`\n" }, { "info": { "name": "Otter Create a Packaging Component", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/order/v1/sources/:source/orders/:orderId/create-packaging-component", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 32 per minute`\n" }, { "info": { "name": "Otter Mark an Order as Fulfilled", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/order/v1/sources/:source/orders/:orderId/fulfill", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 32 per minute`\n" }, { "info": { "name": "Otter Mark a Dine-in (open-tab) Order as Closed", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/order/v1/sources/:source/orders/:orderId/close", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Marks an open-tab dine-in order as closed. The closing party is always the merchant/POS (system). `RATE LIMIT: 32 per minute`\n" }, { "info": { "name": "Otter Update Order Customer Items", "type": "http" }, "http": { "method": "PUT", "url": "https://{public-api-url}/manager/order/v1/sources/:source/orders/:orderId/items", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates customer items for a dine-in order (quantity change, price adjustment, or add item). Only supported when integration slug is d2c-eater-website, order fulfillment type is dine-in, and the order tab is open (order is modifiable). Modifying party and modification request ID are set by the endpoint. `RATE LIMIT: 8 per minute`\n" }, { "info": { "name": "Otter Update Order Prep Time", "type": "http" }, "http": { "method": "POST", "url": "https://{public-api-url}/manager/order/v1/sources/:source/orders/:orderId/prep-time", "headers": [ { "name": "X-Store-Id", "value": "" } ], "params": [ { "name": "source", "value": "", "type": "path" }, { "name": "orderId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "`RATE LIMIT: 32 per minute`\n" } ] } ], "bundled": true }