{ "opencollection": "1.0.0", "info": { "name": "ShootProof Studio API (Curated Subset) Clients Orders API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.shootproof.com/oauth2/authorization/new", "accessTokenUrl": "https://auth.shootproof.com/oauth2/authorization/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of all orders for the current brand", "type": "http" }, "http": { "method": "GET", "url": "https://api.shootproof.com/studio/brand/:brandId/order", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand." } ] }, "docs": "Returns a list of all orders for the current brand" }, { "info": { "name": "Creates a new order for the current brand", "type": "http" }, "http": { "method": "POST", "url": "https://api.shootproof.com/studio/brand/:brandId/order", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new order for the current brand" }, { "info": { "name": "Returns a single order by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.shootproof.com/studio/brand/:brandId/order/:orderId", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand." }, { "name": "orderId", "value": "", "type": "path", "description": "The ID of the order." } ] }, "docs": "Returns a single order by ID" }, { "info": { "name": "Removes an order by changing its status to deleted", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.shootproof.com/studio/brand/:brandId/order/:orderId", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand." }, { "name": "orderId", "value": "", "type": "path", "description": "The ID of the order." } ] }, "docs": "Removes an order by changing its status to deleted" }, { "info": { "name": "Returns a list of all order items for the current order", "type": "http" }, "http": { "method": "GET", "url": "https://api.shootproof.com/studio/brand/:brandId/order/:orderId/item", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand." }, { "name": "orderId", "value": "", "type": "path", "description": "The ID of the order." } ] }, "docs": "Returns a list of all order items for the current order" }, { "info": { "name": "Adds new order items for each photo ID provided in the request", "type": "http" }, "http": { "method": "POST", "url": "https://api.shootproof.com/studio/brand/:brandId/order/:orderId/item", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand." }, { "name": "orderId", "value": "", "type": "path", "description": "The ID of the order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds new order items for each photo ID provided in the request" }, { "info": { "name": "Transmits an order receipt email with transaction details", "type": "http" }, "http": { "method": "POST", "url": "https://api.shootproof.com/studio/brand/:brandId/order/:orderId/email", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand." }, { "name": "orderId", "value": "", "type": "path", "description": "The ID of the order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transmits an order receipt email with transaction details" }, { "info": { "name": "Generates lab shipment records for order fulfillment", "type": "http" }, "http": { "method": "POST", "url": "https://api.shootproof.com/studio/brand/:brandId/order/:orderId/lab-shipment", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand." }, { "name": "orderId", "value": "", "type": "path", "description": "The ID of the order." } ] }, "docs": "Generates lab shipment records for order fulfillment" }, { "info": { "name": "Lists all client payment records associated with an order", "type": "http" }, "http": { "method": "GET", "url": "https://api.shootproof.com/studio/brand/:brandId/order/:orderId/payment", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand." }, { "name": "orderId", "value": "", "type": "path", "description": "The ID of the order." } ] }, "docs": "Lists all client payment records associated with an order" } ] } ], "bundled": true }