--- agentTools: projectIndex: https://sendinblue.readme.io/llms.txt --- # Get order details Get all the orders # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "contact": { "email": "contact@brevo.com", "name": "Brevo Support", "url": "https://account.brevo.com/support" }, "description": "Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :\n - Manage your campaigns and get the statistics\n - Manage your contacts\n - Send transactional Emails and SMS\n - and much more...\n\nYou can download our wrappers at https://github.com/orgs/brevo\n**Possible responses**\n | Code | Message |\n | :-------------: | ------------- |\n | 200 | OK. Successful Request |\n | 201 | OK. Successful Creation |\n | 202 | OK. Request accepted |\n | 204 | OK. Successful Update/Deletion |\n | 400 | Error. Bad Request |\n | 401 | Error. Authentication Needed |\n | 402 | Error. Not enough credit, plan upgrade needed |\n | 403 | Error. Permission denied |\n | 404 | Error. Object does not exist |\n | 405 | Error. Method not allowed |\n | 406 | Error. Not Acceptable |\n | 422 | Error. Unprocessable Entity |\n", "license": { "name": "MIT", "url": "http://opensource.org/licenses/MIT" }, "title": "Brevo API", "version": "3.0.0" }, "servers": [ { "url": "https://api.brevo.com/v3" } ], "security": [ { "api-key": [] }, { "partner-key": [] } ], "paths": { "/orders": { "get": { "description": "Get all the orders", "operationId": "getOrders", "parameters": [ { "description": "Number of documents per page", "in": "query", "name": "limit", "schema": { "default": 50, "format": "int64", "maximum": 100, "type": "integer" } }, { "description": "Index of the first document in the page", "in": "query", "name": "offset", "schema": { "default": 0, "format": "int64", "type": "integer" } }, { "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "in": "query", "name": "sort", "required": false, "schema": { "default": "desc", "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**\n", "in": "query", "name": "modifiedSince", "schema": { "type": "string" } }, { "description": "Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**\n", "in": "query", "name": "createdSince", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "count": 1, "orders": [ { "amount": 2000, "billing": { "address": "Sec 62, Noida", "city": "Noida", "country": "India", "countryCode": "IN", "paymentMethod": "Net banking", "phone": 9238283982, "postCode": 110001, "region": "North India" }, "contact_id": 2, "coupons": [ "flat50", "flat40" ], "createdAt": "2021-12-31T11:42:35.638Z", "email": "testvisitor@sendinblue.com", "id": "order1803", "identifiers": { "ext_id": "ab12", "loyalty_subscription_id": "1234" }, "products": [ { "price": 100, "productId": 21, "quantity": 2, "variantId": "P100" }, { "price": 100, "productId": 21, "quantity": 2, "variantId": "P15756" } ], "status": "complete", "storeId": "123", "updatedAt": "2022-03-03T14:48:31.867Z" } ] } } } } }, "description": "orders fetched successfully" }, "400": { "$ref": "#/components/responses/errorModel" } }, "summary": "Get order details", "tags": [ "Ecommerce" ] } } }, "components": { "securitySchemes": { "api-key": { "description": "The API key should be passed in the request headers as `api-key` for authentication.", "in": "header", "name": "api-key", "type": "apiKey" }, "partner-key": { "description": "The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional).", "in": "header", "name": "partner-key", "type": "apiKey" } }, "responses": { "errorModel": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "Error code displayed in case of a failure", "enum": [ "invalid_parameter", "missing_parameter", "out_of_range", "campaign_processing", "campaign_sent", "document_not_found", "not_enough_credits", "permission_denied", "duplicate_parameter", "duplicate_request", "method_not_allowed", "unauthorized", "account_under_validation", "not_acceptable", "bad_request", "unprocessable_entity", "Domain does not exist", "Contact email not found", "Attribute not found", "Category id not found", "Invalid parameters passed", "Record(s) for identifier not found", "Returned when query params are invalid", "Returned when invalid data posted", "Feed not found", "Campaign ID not found", "api-key not found", "DMARC policy requires domain authentication", "DNS records not properly configured", "Invalid OTP code provided", "OTP code has expired", "Domain already exists in your account", "The sum of all IP weights must equal 100", "Authentication failed", "Insufficient credits", "Request already processed" ], "example": "method_not_allowed", "type": "string" }, "message": { "description": "Readable message associated to the failure", "example": "POST Method is not allowed on this path", "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "bad request" } } }, "x-samples-languages": [ "curl" ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 91, "1": 104, "2": 180, "3": 205, "4": 240, "5": 82, "6": 207, "7": 0, "8": 3, "9": 36, "10": 63, "11": 142 } } } ```