---
title: /orders
slug: orders
createdAt: 2023-07-20T14:59:31.346Z
---
{
"id": "4jOq8SEhuQBHp3Zb_VRCh",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "/orders",
"name": "/orders",
"description": "Cria o pedido em status inicial retornando valores de cashback a ser resgatado e recebido, entre outras informações importantes para finalizar o pedido.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "object",
"customType": "CreateOrderDto",
"schema": [
{
"name": "external_id",
"kind": "required",
"type": "string",
"description": "Identificador externo do pedido"
},
{
"name": "items",
"kind": "required",
"type": "array",
"description": "Lista de items do pedido",
"modelRef": "#/components/schemas/ItemDto",
"customType": "ItemDto[]",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "Identificador do item"
},
{
"name": "price",
"kind": "required",
"type": "number",
"description": "Preço unitário em centavos do item"
},
{
"name": "description",
"kind": "required",
"type": "string",
"description": "Descrição do item"
}
]
},
{
"name": "document",
"kind": "required",
"type": "string",
"description": "Documento do consumidor",
"example": "12345678901"
},
{
"name": "total",
"kind": "required",
"type": "number",
"description": "Valor total do pedido em centavos"
},
{
"name": "discount",
"kind": "optional",
"type": "number",
"description": "Valor a ser descontado do total do pedido e itens"
},
{
"name": "delivery_date",
"kind": "optional",
"type": "string",
"description": "Data estimada para entrega do pedido"
},
{
"name": "filial",
"kind": "optional",
"type": "string",
"description": "Nome da loja"
},
{
"name": "codigoFilial",
"kind": "optional",
"type": "string",
"description": "Identificador da loja"
},
{
"name": "payment_methods",
"kind": "optional",
"type": "array",
"description": "Lista de métodos de pagamento",
"modelRef": "#/components/schemas/PaymentMethodsItemDto",
"customType": "PaymentMethodsItemDto[]",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "Identificador externo do método de pagamento"
},
{
"name": "amount",
"kind": "required",
"type": "number",
"description": "Valor pago em centavos"
}
]
}
],
"modelRef": "#/components/schemas/CreateOrderDto",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": []
},
"responses": [
{
"statusCode": "201",
"description": "Pedido criado com sucesso",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"customType": "OrderResultDto",
"schema": [
{
"name": "id",
"kind": "required",
"type": "number",
"description": "Identificador do pedido na Opencashback"
},
{
"name": "configuration_id",
"kind": "required",
"type": "number",
"description": "Identificador da configuração usada para criar o pedido"
},
{
"name": "customer_profile_id",
"kind": "required",
"type": "number",
"description": "Identificador do perfil do consumidor"
},
{
"name": "external_id",
"kind": "required",
"type": "string",
"description": "Identificador externo do pedido"
},
{
"name": "items",
"kind": "optional",
"type": "array",
"description": "Lista de items do pedido",
"modelRef": "#/components/schemas/ItemDto",
"customType": "ItemDto[]",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "Identificador do item"
},
{
"name": "price",
"kind": "required",
"type": "number",
"description": "Preço unitário em centavos do item"
},
{
"name": "description",
"kind": "required",
"type": "string",
"description": "Descrição do item"
}
]
},
{
"name": "document",
"kind": "optional",
"type": "string",
"description": "Documento do consumidor",
"example": "12345678901"
},
{
"name": "total",
"kind": "required",
"type": "number",
"description": "Valor total do pedido em centavos"
},
{
"name": "discount",
"kind": "required",
"type": "number",
"description": "Valor a ser descontado do total do pedido e itens"
},
{
"name": "delivery_date",
"kind": "optional",
"type": "string",
"description": "Data estimada para entrega do pedido"
},
{
"name": "filial",
"kind": "optional",
"type": "string",
"description": "Nome da loja"
},
{
"name": "codigoFilial",
"kind": "optional",
"type": "string",
"description": "Identificador da loja"
},
{
"name": "cashback",
"kind": "optional",
"type": "number",
"description": "Valor de cashback a ser resgatado"
},
{
"name": "status",
"kind": "required",
"type": "string",
"description": "Status do pedido",
"example": "created",
"default": "created"
},
{
"name": "two_factor",
"kind": "required",
"type": "boolean",
"description": "Solicita autenticação para o pedido",
"example": false,
"default": false
},
{
"name": "payment_methods",
"kind": "optional",
"type": "array",
"description": "Lista de métodos de pagamento",
"modelRef": "#/components/schemas/PaymentMethodsItemDto",
"customType": "PaymentMethodsItemDto[]",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "Identificador externo do método de pagamento"
},
{
"name": "amount",
"kind": "required",
"type": "number",
"description": "Valor pago em centavos"
}
]
},
{
"name": "cashback_received",
"kind": "required",
"type": "number",
"description": "Valor de cashback a ser acumulado"
},
{
"name": "cashback_limit",
"kind": "required",
"type": "number",
"description": "Valor máximo de cashback a ser resgatado"
},
{
"name": "created_at",
"kind": "required",
"type": "string",
"description": "Data de criação do pedido"
},
{
"name": "updated_at",
"kind": "required",
"type": "string",
"description": "Data da última atualização do pedido"
}
],
"modelRef": "#/components/schemas/OrderResultDto",
"isExpanded": true
}
]
}
],
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url /orders \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"external_id\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"price\": \"\",\n \"description\": \"\"\n }\n ],\n \"document\": \"12345678901\",\n \"total\": \"\",\n \"payment_methods\": [\n {\n \"id\": \"\",\n \"amount\": \"\"\n }\n ]\n }'"
},
{
"id": "example-1-javascript",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"external_id\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"price\": \"\",\n \"description\": \"\"\n }\n ],\n \"document\": \"12345678901\",\n \"total\": \"\",\n \"payment_methods\": [\n {\n \"id\": \"\",\n \"amount\": \"\"\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"/orders\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "example-2-ruby",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/orders\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"external_id\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"price\": \"\",\n \"description\": \"\"\n }\n ],\n \"document\": \"12345678901\",\n \"total\": \"\",\n \"payment_methods\": [\n {\n \"id\": \"\",\n \"amount\": \"\"\n }\n ]\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
},
{
"id": "example-3-python",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"/orders\"\n\npayload = json.dumps({\n \"external_id\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"price\": \"\",\n \"description\": \"\"\n }\n ],\n \"document\": \"12345678901\",\n \"total\": \"\",\n \"payment_methods\": [\n {\n \"id\": \"\",\n \"amount\": \"\"\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "example-0-curl"
},
"results": {
"languages": [
{
"id": "response-0-201",
"language": "201",
"code": "// Pedido criado com sucesso\n{\n \"id\": 0,\n \"configuration_id\": 0,\n \"customer_profile_id\": 0,\n \"external_id\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"price\": 0,\n \"description\": \"\"\n }\n ],\n \"document\": \"12345678901\",\n \"total\": 0,\n \"discount\": 0,\n \"delivery_date\": \"\",\n \"filial\": \"\",\n \"codigoFilial\": \"\",\n \"cashback\": 0,\n \"status\": \"created\",\n \"two_factor\": false,\n \"payment_methods\": [\n {\n \"id\": \"\",\n \"amount\": 0\n }\n ],\n \"cashback_received\": 0,\n \"cashback_limit\": 0,\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"
}
],
"selectedLanguageId": "response-0-201"
}
},
"children": [
{
"id": "LbZxIXSurG1IZBSfM4APZ",
"type": "paragraph",
"children": [
{
"text": "Cria o pedido em status inicial retornando valores de cashback a ser resgatado e recebido, entre outras informações importantes para finalizar o pedido."
}
]
}
]
}