Criar Venda

curl --request POST \
  --url https://api.spedy.com.br/v1/orders \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "amount": 123,
  "date": "2023-11-07T05:31:56Z",
  "items": [
    {
      "quantity": 123,
      "price": 123,
      "amount": 123,
      "product": {
        "name": "<string>",
        "code": "<string>",
        "price": 123
      },
      "description": "<string>",
      "discountAmount": 123,
      "freightAmount": 123
    }
  ],
  "transactionId": "<string>",
  "discountAmount": 123,
  "freightAmount": 123,
  "freight": {
    "carrier": {
      "name": "<string>",
      "legalName": "<string>",
      "federalTaxNumber": "<string>",
      "cityTaxNumber": "<string>",
      "stateTaxNumber": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "mobilePhone": "<string>",
      "address": {
        "street": "<string>",
        "district": "<string>",
        "postalCode": "<string>",
        "number": "<string>",
        "additionalInformation": "<string>",
        "city": {
          "code": "<string>",
          "name": "<string>"
        },
        "cityName": "<string>"
      }
    },
    "volumeQuantity": 123,
    "volumeNumeration": "<string>",
    "species": "<string>",
    "brand": "<string>",
    "grossWeight": 123,
    "netWeight": 123
  },
  "warrantyDate": "2023-11-07T05:31:56Z",
  "sendEmailToCustomer": true,
  "invoices": [
    {
      "issuedOn": "2023-11-07T05:31:56Z",
      "receiver": {
        "name": "<string>",
        "federalTaxNumber": "<string>",
        "stateTaxNumber": "<string>",
        "suframaTaxNumber": "<string>",
        "cityTaxNumber": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "address": {
          "street": "<string>",
          "district": "<string>",
          "postalCode": "<string>",
          "number": "<string>",
          "additionalInformation": "<string>",
          "city": {
            "name": "<string>",
            "state": "<string>",
            "code": 123
          },
          "country": "<string>"
        }
      },
      "additionalInformation": "<string>",
      "effectiveDate": "2023-11-07T05:31:56Z",
      "number": 123
    }
  ],
  "event": {
    "name": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "identifier": "<string>",
    "address": {
      "street": "<string>",
      "district": "<string>",
      "postalCode": "<string>",
      "number": "<string>",
      "additionalInformation": "<string>",
      "city": {
        "name": "<string>",
        "state": "<string>",
        "code": 123
      },
      "country": "<string>"
    }
  }
}
'

import requests

url = "https://api.spedy.com.br/v1/orders"

payload = {
    "amount": 123,
    "date": "2023-11-07T05:31:56Z",
    "items": [
        {
            "quantity": 123,
            "price": 123,
            "amount": 123,
            "product": {
                "name": "<string>",
                "code": "<string>",
                "price": 123
            },
            "description": "<string>",
            "discountAmount": 123,
            "freightAmount": 123
        }
    ],
    "transactionId": "<string>",
    "discountAmount": 123,
    "freightAmount": 123,
    "freight": {
        "carrier": {
            "name": "<string>",
            "legalName": "<string>",
            "federalTaxNumber": "<string>",
            "cityTaxNumber": "<string>",
            "stateTaxNumber": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "mobilePhone": "<string>",
            "address": {
                "street": "<string>",
                "district": "<string>",
                "postalCode": "<string>",
                "number": "<string>",
                "additionalInformation": "<string>",
                "city": {
                    "code": "<string>",
                    "name": "<string>"
                },
                "cityName": "<string>"
            }
        },
        "volumeQuantity": 123,
        "volumeNumeration": "<string>",
        "species": "<string>",
        "brand": "<string>",
        "grossWeight": 123,
        "netWeight": 123
    },
    "warrantyDate": "2023-11-07T05:31:56Z",
    "sendEmailToCustomer": True,
    "invoices": [
        {
            "issuedOn": "2023-11-07T05:31:56Z",
            "receiver": {
                "name": "<string>",
                "federalTaxNumber": "<string>",
                "stateTaxNumber": "<string>",
                "suframaTaxNumber": "<string>",
                "cityTaxNumber": "<string>",
                "email": "<string>",
                "phoneNumber": "<string>",
                "address": {
                    "street": "<string>",
                    "district": "<string>",
                    "postalCode": "<string>",
                    "number": "<string>",
                    "additionalInformation": "<string>",
                    "city": {
                        "name": "<string>",
                        "state": "<string>",
                        "code": 123
                    },
                    "country": "<string>"
                }
            },
            "additionalInformation": "<string>",
            "effectiveDate": "2023-11-07T05:31:56Z",
            "number": 123
        }
    ],
    "event": {
        "name": "<string>",
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z",
        "identifier": "<string>",
        "address": {
            "street": "<string>",
            "district": "<string>",
            "postalCode": "<string>",
            "number": "<string>",
            "additionalInformation": "<string>",
            "city": {
                "name": "<string>",
                "state": "<string>",
                "code": 123
            },
            "country": "<string>"
        }
    }
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    amount: 123,
    date: '2023-11-07T05:31:56Z',
    items: [
      {
        quantity: 123,
        price: 123,
        amount: 123,
        product: {name: '<string>', code: '<string>', price: 123},
        description: '<string>',
        discountAmount: 123,
        freightAmount: 123
      }
    ],
    transactionId: '<string>',
    discountAmount: 123,
    freightAmount: 123,
    freight: {
      carrier: {
        name: '<string>',
        legalName: '<string>',
        federalTaxNumber: '<string>',
        cityTaxNumber: '<string>',
        stateTaxNumber: '<string>',
        email: '<string>',
        phone: '<string>',
        mobilePhone: '<string>',
        address: {
          street: '<string>',
          district: '<string>',
          postalCode: '<string>',
          number: '<string>',
          additionalInformation: '<string>',
          city: {code: '<string>', name: '<string>'},
          cityName: '<string>'
        }
      },
      volumeQuantity: 123,
      volumeNumeration: '<string>',
      species: '<string>',
      brand: '<string>',
      grossWeight: 123,
      netWeight: 123
    },
    warrantyDate: '2023-11-07T05:31:56Z',
    sendEmailToCustomer: true,
    invoices: [
      {
        issuedOn: '2023-11-07T05:31:56Z',
        receiver: {
          name: '<string>',
          federalTaxNumber: '<string>',
          stateTaxNumber: '<string>',
          suframaTaxNumber: '<string>',
          cityTaxNumber: '<string>',
          email: '<string>',
          phoneNumber: '<string>',
          address: {
            street: '<string>',
            district: '<string>',
            postalCode: '<string>',
            number: '<string>',
            additionalInformation: '<string>',
            city: {name: '<string>', state: '<string>', code: 123},
            country: '<string>'
          }
        },
        additionalInformation: '<string>',
        effectiveDate: '2023-11-07T05:31:56Z',
        number: 123
      }
    ],
    event: {
      name: '<string>',
      startDate: '2023-11-07T05:31:56Z',
      endDate: '2023-11-07T05:31:56Z',
      identifier: '<string>',
      address: {
        street: '<string>',
        district: '<string>',
        postalCode: '<string>',
        number: '<string>',
        additionalInformation: '<string>',
        city: {name: '<string>', state: '<string>', code: 123},
        country: '<string>'
      }
    }
  })
};

fetch('https://api.spedy.com.br/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.spedy.com.br/v1/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 123,
    'date' => '2023-11-07T05:31:56Z',
    'items' => [
        [
                'quantity' => 123,
                'price' => 123,
                'amount' => 123,
                'product' => [
                                'name' => '<string>',
                                'code' => '<string>',
                                'price' => 123
                ],
                'description' => '<string>',
                'discountAmount' => 123,
                'freightAmount' => 123
        ]
    ],
    'transactionId' => '<string>',
    'discountAmount' => 123,
    'freightAmount' => 123,
    'freight' => [
        'carrier' => [
                'name' => '<string>',
                'legalName' => '<string>',
                'federalTaxNumber' => '<string>',
                'cityTaxNumber' => '<string>',
                'stateTaxNumber' => '<string>',
                'email' => '<string>',
                'phone' => '<string>',
                'mobilePhone' => '<string>',
                'address' => [
                                'street' => '<string>',
                                'district' => '<string>',
                                'postalCode' => '<string>',
                                'number' => '<string>',
                                'additionalInformation' => '<string>',
                                'city' => [
                                                                'code' => '<string>',
                                                                'name' => '<string>'
                                ],
                                'cityName' => '<string>'
                ]
        ],
        'volumeQuantity' => 123,
        'volumeNumeration' => '<string>',
        'species' => '<string>',
        'brand' => '<string>',
        'grossWeight' => 123,
        'netWeight' => 123
    ],
    'warrantyDate' => '2023-11-07T05:31:56Z',
    'sendEmailToCustomer' => true,
    'invoices' => [
        [
                'issuedOn' => '2023-11-07T05:31:56Z',
                'receiver' => [
                                'name' => '<string>',
                                'federalTaxNumber' => '<string>',
                                'stateTaxNumber' => '<string>',
                                'suframaTaxNumber' => '<string>',
                                'cityTaxNumber' => '<string>',
                                'email' => '<string>',
                                'phoneNumber' => '<string>',
                                'address' => [
                                                                'street' => '<string>',
                                                                'district' => '<string>',
                                                                'postalCode' => '<string>',
                                                                'number' => '<string>',
                                                                'additionalInformation' => '<string>',
                                                                'city' => [
                                                                                                                                'name' => '<string>',
                                                                                                                                'state' => '<string>',
                                                                                                                                'code' => 123
                                                                ],
                                                                'country' => '<string>'
                                ]
                ],
                'additionalInformation' => '<string>',
                'effectiveDate' => '2023-11-07T05:31:56Z',
                'number' => 123
        ]
    ],
    'event' => [
        'name' => '<string>',
        'startDate' => '2023-11-07T05:31:56Z',
        'endDate' => '2023-11-07T05:31:56Z',
        'identifier' => '<string>',
        'address' => [
                'street' => '<string>',
                'district' => '<string>',
                'postalCode' => '<string>',
                'number' => '<string>',
                'additionalInformation' => '<string>',
                'city' => [
                                'name' => '<string>',
                                'state' => '<string>',
                                'code' => 123
                ],
                'country' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spedy.com.br/v1/orders"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"date\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"quantity\": 123,\n      \"price\": 123,\n      \"amount\": 123,\n      \"product\": {\n        \"name\": \"<string>\",\n        \"code\": \"<string>\",\n        \"price\": 123\n      },\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"freightAmount\": 123\n    }\n  ],\n  \"transactionId\": \"<string>\",\n  \"discountAmount\": 123,\n  \"freightAmount\": 123,\n  \"freight\": {\n    \"carrier\": {\n      \"name\": \"<string>\",\n      \"legalName\": \"<string>\",\n      \"federalTaxNumber\": \"<string>\",\n      \"cityTaxNumber\": \"<string>\",\n      \"stateTaxNumber\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"mobilePhone\": \"<string>\",\n      \"address\": {\n        \"street\": \"<string>\",\n        \"district\": \"<string>\",\n        \"postalCode\": \"<string>\",\n        \"number\": \"<string>\",\n        \"additionalInformation\": \"<string>\",\n        \"city\": {\n          \"code\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"cityName\": \"<string>\"\n      }\n    },\n    \"volumeQuantity\": 123,\n    \"volumeNumeration\": \"<string>\",\n    \"species\": \"<string>\",\n    \"brand\": \"<string>\",\n    \"grossWeight\": 123,\n    \"netWeight\": 123\n  },\n  \"warrantyDate\": \"2023-11-07T05:31:56Z\",\n  \"sendEmailToCustomer\": true,\n  \"invoices\": [\n    {\n      \"issuedOn\": \"2023-11-07T05:31:56Z\",\n      \"receiver\": {\n        \"name\": \"<string>\",\n        \"federalTaxNumber\": \"<string>\",\n        \"stateTaxNumber\": \"<string>\",\n        \"suframaTaxNumber\": \"<string>\",\n        \"cityTaxNumber\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phoneNumber\": \"<string>\",\n        \"address\": {\n          \"street\": \"<string>\",\n          \"district\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"number\": \"<string>\",\n          \"additionalInformation\": \"<string>\",\n          \"city\": {\n            \"name\": \"<string>\",\n            \"state\": \"<string>\",\n            \"code\": 123\n          },\n          \"country\": \"<string>\"\n        }\n      },\n      \"additionalInformation\": \"<string>\",\n      \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n      \"number\": 123\n    }\n  ],\n  \"event\": {\n    \"name\": \"<string>\",\n    \"startDate\": \"2023-11-07T05:31:56Z\",\n    \"endDate\": \"2023-11-07T05:31:56Z\",\n    \"identifier\": \"<string>\",\n    \"address\": {\n      \"street\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"number\": \"<string>\",\n      \"additionalInformation\": \"<string>\",\n      \"city\": {\n        \"name\": \"<string>\",\n        \"state\": \"<string>\",\n        \"code\": 123\n      },\n      \"country\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.spedy.com.br/v1/orders")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"amount\": 123,\n  \"date\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"quantity\": 123,\n      \"price\": 123,\n      \"amount\": 123,\n      \"product\": {\n        \"name\": \"<string>\",\n        \"code\": \"<string>\",\n        \"price\": 123\n      },\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"freightAmount\": 123\n    }\n  ],\n  \"transactionId\": \"<string>\",\n  \"discountAmount\": 123,\n  \"freightAmount\": 123,\n  \"freight\": {\n    \"carrier\": {\n      \"name\": \"<string>\",\n      \"legalName\": \"<string>\",\n      \"federalTaxNumber\": \"<string>\",\n      \"cityTaxNumber\": \"<string>\",\n      \"stateTaxNumber\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"mobilePhone\": \"<string>\",\n      \"address\": {\n        \"street\": \"<string>\",\n        \"district\": \"<string>\",\n        \"postalCode\": \"<string>\",\n        \"number\": \"<string>\",\n        \"additionalInformation\": \"<string>\",\n        \"city\": {\n          \"code\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"cityName\": \"<string>\"\n      }\n    },\n    \"volumeQuantity\": 123,\n    \"volumeNumeration\": \"<string>\",\n    \"species\": \"<string>\",\n    \"brand\": \"<string>\",\n    \"grossWeight\": 123,\n    \"netWeight\": 123\n  },\n  \"warrantyDate\": \"2023-11-07T05:31:56Z\",\n  \"sendEmailToCustomer\": true,\n  \"invoices\": [\n    {\n      \"issuedOn\": \"2023-11-07T05:31:56Z\",\n      \"receiver\": {\n        \"name\": \"<string>\",\n        \"federalTaxNumber\": \"<string>\",\n        \"stateTaxNumber\": \"<string>\",\n        \"suframaTaxNumber\": \"<string>\",\n        \"cityTaxNumber\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phoneNumber\": \"<string>\",\n        \"address\": {\n          \"street\": \"<string>\",\n          \"district\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"number\": \"<string>\",\n          \"additionalInformation\": \"<string>\",\n          \"city\": {\n            \"name\": \"<string>\",\n            \"state\": \"<string>\",\n            \"code\": 123\n          },\n          \"country\": \"<string>\"\n        }\n      },\n      \"additionalInformation\": \"<string>\",\n      \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n      \"number\": 123\n    }\n  ],\n  \"event\": {\n    \"name\": \"<string>\",\n    \"startDate\": \"2023-11-07T05:31:56Z\",\n    \"endDate\": \"2023-11-07T05:31:56Z\",\n    \"identifier\": \"<string>\",\n    \"address\": {\n      \"street\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"number\": \"<string>\",\n      \"additionalInformation\": \"<string>\",\n      \"city\": {\n        \"name\": \"<string>\",\n        \"state\": \"<string>\",\n        \"code\": 123\n      },\n      \"country\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spedy.com.br/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"amount\": 123,\n  \"date\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"quantity\": 123,\n      \"price\": 123,\n      \"amount\": 123,\n      \"product\": {\n        \"name\": \"<string>\",\n        \"code\": \"<string>\",\n        \"price\": 123\n      },\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"freightAmount\": 123\n    }\n  ],\n  \"transactionId\": \"<string>\",\n  \"discountAmount\": 123,\n  \"freightAmount\": 123,\n  \"freight\": {\n    \"carrier\": {\n      \"name\": \"<string>\",\n      \"legalName\": \"<string>\",\n      \"federalTaxNumber\": \"<string>\",\n      \"cityTaxNumber\": \"<string>\",\n      \"stateTaxNumber\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"mobilePhone\": \"<string>\",\n      \"address\": {\n        \"street\": \"<string>\",\n        \"district\": \"<string>\",\n        \"postalCode\": \"<string>\",\n        \"number\": \"<string>\",\n        \"additionalInformation\": \"<string>\",\n        \"city\": {\n          \"code\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"cityName\": \"<string>\"\n      }\n    },\n    \"volumeQuantity\": 123,\n    \"volumeNumeration\": \"<string>\",\n    \"species\": \"<string>\",\n    \"brand\": \"<string>\",\n    \"grossWeight\": 123,\n    \"netWeight\": 123\n  },\n  \"warrantyDate\": \"2023-11-07T05:31:56Z\",\n  \"sendEmailToCustomer\": true,\n  \"invoices\": [\n    {\n      \"issuedOn\": \"2023-11-07T05:31:56Z\",\n      \"receiver\": {\n        \"name\": \"<string>\",\n        \"federalTaxNumber\": \"<string>\",\n        \"stateTaxNumber\": \"<string>\",\n        \"suframaTaxNumber\": \"<string>\",\n        \"cityTaxNumber\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phoneNumber\": \"<string>\",\n        \"address\": {\n          \"street\": \"<string>\",\n          \"district\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"number\": \"<string>\",\n          \"additionalInformation\": \"<string>\",\n          \"city\": {\n            \"name\": \"<string>\",\n            \"state\": \"<string>\",\n            \"code\": 123\n          },\n          \"country\": \"<string>\"\n        }\n      },\n      \"additionalInformation\": \"<string>\",\n      \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n      \"number\": 123\n    }\n  ],\n  \"event\": {\n    \"name\": \"<string>\",\n    \"startDate\": \"2023-11-07T05:31:56Z\",\n    \"endDate\": \"2023-11-07T05:31:56Z\",\n    \"identifier\": \"<string>\",\n    \"address\": {\n      \"street\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"number\": \"<string>\",\n      \"additionalInformation\": \"<string>\",\n      \"city\": {\n        \"name\": \"<string>\",\n        \"state\": \"<string>\",\n        \"code\": 123\n      },\n      \"country\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactionId": "<string>",
  "date": "2023-11-07T05:31:56Z",
  "customer": {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "legalName": "<string>",
    "federalTaxNumber": "<string>",
    "cityTaxNumber": "<string>",
    "stateTaxNumber": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "mobilePhone": "<string>",
    "address": {
      "street": "<string>",
      "district": "<string>",
      "postalCode": "<string>",
      "number": "<string>",
      "additionalInformation": "<string>",
      "city": {
        "code": "<string>",
        "name": "<string>"
      },
      "country": {
        "name": "<string>",
        "code": 123
      },
      "cityName": "<string>"
    }
  },
  "amount": 123,
  "items": [
    {
      "quantity": 123,
      "price": 123,
      "amount": 123,
      "product": {
        "name": "<string>",
        "code": "<string>",
        "price": 123
      },
      "description": "<string>",
      "discountAmount": 123,
      "freightAmount": 123
    }
  ],
  "invoices": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "processingDetail": {
        "message": "<string>",
        "code": "<string>",
        "on": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

POST

orders

Criar Venda

curl --request POST \
  --url https://api.spedy.com.br/v1/orders \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "amount": 123,
  "date": "2023-11-07T05:31:56Z",
  "items": [
    {
      "quantity": 123,
      "price": 123,
      "amount": 123,
      "product": {
        "name": "<string>",
        "code": "<string>",
        "price": 123
      },
      "description": "<string>",
      "discountAmount": 123,
      "freightAmount": 123
    }
  ],
  "transactionId": "<string>",
  "discountAmount": 123,
  "freightAmount": 123,
  "freight": {
    "carrier": {
      "name": "<string>",
      "legalName": "<string>",
      "federalTaxNumber": "<string>",
      "cityTaxNumber": "<string>",
      "stateTaxNumber": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "mobilePhone": "<string>",
      "address": {
        "street": "<string>",
        "district": "<string>",
        "postalCode": "<string>",
        "number": "<string>",
        "additionalInformation": "<string>",
        "city": {
          "code": "<string>",
          "name": "<string>"
        },
        "cityName": "<string>"
      }
    },
    "volumeQuantity": 123,
    "volumeNumeration": "<string>",
    "species": "<string>",
    "brand": "<string>",
    "grossWeight": 123,
    "netWeight": 123
  },
  "warrantyDate": "2023-11-07T05:31:56Z",
  "sendEmailToCustomer": true,
  "invoices": [
    {
      "issuedOn": "2023-11-07T05:31:56Z",
      "receiver": {
        "name": "<string>",
        "federalTaxNumber": "<string>",
        "stateTaxNumber": "<string>",
        "suframaTaxNumber": "<string>",
        "cityTaxNumber": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "address": {
          "street": "<string>",
          "district": "<string>",
          "postalCode": "<string>",
          "number": "<string>",
          "additionalInformation": "<string>",
          "city": {
            "name": "<string>",
            "state": "<string>",
            "code": 123
          },
          "country": "<string>"
        }
      },
      "additionalInformation": "<string>",
      "effectiveDate": "2023-11-07T05:31:56Z",
      "number": 123
    }
  ],
  "event": {
    "name": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "identifier": "<string>",
    "address": {
      "street": "<string>",
      "district": "<string>",
      "postalCode": "<string>",
      "number": "<string>",
      "additionalInformation": "<string>",
      "city": {
        "name": "<string>",
        "state": "<string>",
        "code": 123
      },
      "country": "<string>"
    }
  }
}
'

import requests

url = "https://api.spedy.com.br/v1/orders"

payload = {
    "amount": 123,
    "date": "2023-11-07T05:31:56Z",
    "items": [
        {
            "quantity": 123,
            "price": 123,
            "amount": 123,
            "product": {
                "name": "<string>",
                "code": "<string>",
                "price": 123
            },
            "description": "<string>",
            "discountAmount": 123,
            "freightAmount": 123
        }
    ],
    "transactionId": "<string>",
    "discountAmount": 123,
    "freightAmount": 123,
    "freight": {
        "carrier": {
            "name": "<string>",
            "legalName": "<string>",
            "federalTaxNumber": "<string>",
            "cityTaxNumber": "<string>",
            "stateTaxNumber": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "mobilePhone": "<string>",
            "address": {
                "street": "<string>",
                "district": "<string>",
                "postalCode": "<string>",
                "number": "<string>",
                "additionalInformation": "<string>",
                "city": {
                    "code": "<string>",
                    "name": "<string>"
                },
                "cityName": "<string>"
            }
        },
        "volumeQuantity": 123,
        "volumeNumeration": "<string>",
        "species": "<string>",
        "brand": "<string>",
        "grossWeight": 123,
        "netWeight": 123
    },
    "warrantyDate": "2023-11-07T05:31:56Z",
    "sendEmailToCustomer": True,
    "invoices": [
        {
            "issuedOn": "2023-11-07T05:31:56Z",
            "receiver": {
                "name": "<string>",
                "federalTaxNumber": "<string>",
                "stateTaxNumber": "<string>",
                "suframaTaxNumber": "<string>",
                "cityTaxNumber": "<string>",
                "email": "<string>",
                "phoneNumber": "<string>",
                "address": {
                    "street": "<string>",
                    "district": "<string>",
                    "postalCode": "<string>",
                    "number": "<string>",
                    "additionalInformation": "<string>",
                    "city": {
                        "name": "<string>",
                        "state": "<string>",
                        "code": 123
                    },
                    "country": "<string>"
                }
            },
            "additionalInformation": "<string>",
            "effectiveDate": "2023-11-07T05:31:56Z",
            "number": 123
        }
    ],
    "event": {
        "name": "<string>",
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z",
        "identifier": "<string>",
        "address": {
            "street": "<string>",
            "district": "<string>",
            "postalCode": "<string>",
            "number": "<string>",
            "additionalInformation": "<string>",
            "city": {
                "name": "<string>",
                "state": "<string>",
                "code": 123
            },
            "country": "<string>"
        }
    }
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    amount: 123,
    date: '2023-11-07T05:31:56Z',
    items: [
      {
        quantity: 123,
        price: 123,
        amount: 123,
        product: {name: '<string>', code: '<string>', price: 123},
        description: '<string>',
        discountAmount: 123,
        freightAmount: 123
      }
    ],
    transactionId: '<string>',
    discountAmount: 123,
    freightAmount: 123,
    freight: {
      carrier: {
        name: '<string>',
        legalName: '<string>',
        federalTaxNumber: '<string>',
        cityTaxNumber: '<string>',
        stateTaxNumber: '<string>',
        email: '<string>',
        phone: '<string>',
        mobilePhone: '<string>',
        address: {
          street: '<string>',
          district: '<string>',
          postalCode: '<string>',
          number: '<string>',
          additionalInformation: '<string>',
          city: {code: '<string>', name: '<string>'},
          cityName: '<string>'
        }
      },
      volumeQuantity: 123,
      volumeNumeration: '<string>',
      species: '<string>',
      brand: '<string>',
      grossWeight: 123,
      netWeight: 123
    },
    warrantyDate: '2023-11-07T05:31:56Z',
    sendEmailToCustomer: true,
    invoices: [
      {
        issuedOn: '2023-11-07T05:31:56Z',
        receiver: {
          name: '<string>',
          federalTaxNumber: '<string>',
          stateTaxNumber: '<string>',
          suframaTaxNumber: '<string>',
          cityTaxNumber: '<string>',
          email: '<string>',
          phoneNumber: '<string>',
          address: {
            street: '<string>',
            district: '<string>',
            postalCode: '<string>',
            number: '<string>',
            additionalInformation: '<string>',
            city: {name: '<string>', state: '<string>', code: 123},
            country: '<string>'
          }
        },
        additionalInformation: '<string>',
        effectiveDate: '2023-11-07T05:31:56Z',
        number: 123
      }
    ],
    event: {
      name: '<string>',
      startDate: '2023-11-07T05:31:56Z',
      endDate: '2023-11-07T05:31:56Z',
      identifier: '<string>',
      address: {
        street: '<string>',
        district: '<string>',
        postalCode: '<string>',
        number: '<string>',
        additionalInformation: '<string>',
        city: {name: '<string>', state: '<string>', code: 123},
        country: '<string>'
      }
    }
  })
};

fetch('https://api.spedy.com.br/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.spedy.com.br/v1/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 123,
    'date' => '2023-11-07T05:31:56Z',
    'items' => [
        [
                'quantity' => 123,
                'price' => 123,
                'amount' => 123,
                'product' => [
                                'name' => '<string>',
                                'code' => '<string>',
                                'price' => 123
                ],
                'description' => '<string>',
                'discountAmount' => 123,
                'freightAmount' => 123
        ]
    ],
    'transactionId' => '<string>',
    'discountAmount' => 123,
    'freightAmount' => 123,
    'freight' => [
        'carrier' => [
                'name' => '<string>',
                'legalName' => '<string>',
                'federalTaxNumber' => '<string>',
                'cityTaxNumber' => '<string>',
                'stateTaxNumber' => '<string>',
                'email' => '<string>',
                'phone' => '<string>',
                'mobilePhone' => '<string>',
                'address' => [
                                'street' => '<string>',
                                'district' => '<string>',
                                'postalCode' => '<string>',
                                'number' => '<string>',
                                'additionalInformation' => '<string>',
                                'city' => [
                                                                'code' => '<string>',
                                                                'name' => '<string>'
                                ],
                                'cityName' => '<string>'
                ]
        ],
        'volumeQuantity' => 123,
        'volumeNumeration' => '<string>',
        'species' => '<string>',
        'brand' => '<string>',
        'grossWeight' => 123,
        'netWeight' => 123
    ],
    'warrantyDate' => '2023-11-07T05:31:56Z',
    'sendEmailToCustomer' => true,
    'invoices' => [
        [
                'issuedOn' => '2023-11-07T05:31:56Z',
                'receiver' => [
                                'name' => '<string>',
                                'federalTaxNumber' => '<string>',
                                'stateTaxNumber' => '<string>',
                                'suframaTaxNumber' => '<string>',
                                'cityTaxNumber' => '<string>',
                                'email' => '<string>',
                                'phoneNumber' => '<string>',
                                'address' => [
                                                                'street' => '<string>',
                                                                'district' => '<string>',
                                                                'postalCode' => '<string>',
                                                                'number' => '<string>',
                                                                'additionalInformation' => '<string>',
                                                                'city' => [
                                                                                                                                'name' => '<string>',
                                                                                                                                'state' => '<string>',
                                                                                                                                'code' => 123
                                                                ],
                                                                'country' => '<string>'
                                ]
                ],
                'additionalInformation' => '<string>',
                'effectiveDate' => '2023-11-07T05:31:56Z',
                'number' => 123
        ]
    ],
    'event' => [
        'name' => '<string>',
        'startDate' => '2023-11-07T05:31:56Z',
        'endDate' => '2023-11-07T05:31:56Z',
        'identifier' => '<string>',
        'address' => [
                'street' => '<string>',
                'district' => '<string>',
                'postalCode' => '<string>',
                'number' => '<string>',
                'additionalInformation' => '<string>',
                'city' => [
                                'name' => '<string>',
                                'state' => '<string>',
                                'code' => 123
                ],
                'country' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spedy.com.br/v1/orders"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"date\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"quantity\": 123,\n      \"price\": 123,\n      \"amount\": 123,\n      \"product\": {\n        \"name\": \"<string>\",\n        \"code\": \"<string>\",\n        \"price\": 123\n      },\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"freightAmount\": 123\n    }\n  ],\n  \"transactionId\": \"<string>\",\n  \"discountAmount\": 123,\n  \"freightAmount\": 123,\n  \"freight\": {\n    \"carrier\": {\n      \"name\": \"<string>\",\n      \"legalName\": \"<string>\",\n      \"federalTaxNumber\": \"<string>\",\n      \"cityTaxNumber\": \"<string>\",\n      \"stateTaxNumber\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"mobilePhone\": \"<string>\",\n      \"address\": {\n        \"street\": \"<string>\",\n        \"district\": \"<string>\",\n        \"postalCode\": \"<string>\",\n        \"number\": \"<string>\",\n        \"additionalInformation\": \"<string>\",\n        \"city\": {\n          \"code\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"cityName\": \"<string>\"\n      }\n    },\n    \"volumeQuantity\": 123,\n    \"volumeNumeration\": \"<string>\",\n    \"species\": \"<string>\",\n    \"brand\": \"<string>\",\n    \"grossWeight\": 123,\n    \"netWeight\": 123\n  },\n  \"warrantyDate\": \"2023-11-07T05:31:56Z\",\n  \"sendEmailToCustomer\": true,\n  \"invoices\": [\n    {\n      \"issuedOn\": \"2023-11-07T05:31:56Z\",\n      \"receiver\": {\n        \"name\": \"<string>\",\n        \"federalTaxNumber\": \"<string>\",\n        \"stateTaxNumber\": \"<string>\",\n        \"suframaTaxNumber\": \"<string>\",\n        \"cityTaxNumber\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phoneNumber\": \"<string>\",\n        \"address\": {\n          \"street\": \"<string>\",\n          \"district\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"number\": \"<string>\",\n          \"additionalInformation\": \"<string>\",\n          \"city\": {\n            \"name\": \"<string>\",\n            \"state\": \"<string>\",\n            \"code\": 123\n          },\n          \"country\": \"<string>\"\n        }\n      },\n      \"additionalInformation\": \"<string>\",\n      \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n      \"number\": 123\n    }\n  ],\n  \"event\": {\n    \"name\": \"<string>\",\n    \"startDate\": \"2023-11-07T05:31:56Z\",\n    \"endDate\": \"2023-11-07T05:31:56Z\",\n    \"identifier\": \"<string>\",\n    \"address\": {\n      \"street\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"number\": \"<string>\",\n      \"additionalInformation\": \"<string>\",\n      \"city\": {\n        \"name\": \"<string>\",\n        \"state\": \"<string>\",\n        \"code\": 123\n      },\n      \"country\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.spedy.com.br/v1/orders")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"amount\": 123,\n  \"date\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"quantity\": 123,\n      \"price\": 123,\n      \"amount\": 123,\n      \"product\": {\n        \"name\": \"<string>\",\n        \"code\": \"<string>\",\n        \"price\": 123\n      },\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"freightAmount\": 123\n    }\n  ],\n  \"transactionId\": \"<string>\",\n  \"discountAmount\": 123,\n  \"freightAmount\": 123,\n  \"freight\": {\n    \"carrier\": {\n      \"name\": \"<string>\",\n      \"legalName\": \"<string>\",\n      \"federalTaxNumber\": \"<string>\",\n      \"cityTaxNumber\": \"<string>\",\n      \"stateTaxNumber\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"mobilePhone\": \"<string>\",\n      \"address\": {\n        \"street\": \"<string>\",\n        \"district\": \"<string>\",\n        \"postalCode\": \"<string>\",\n        \"number\": \"<string>\",\n        \"additionalInformation\": \"<string>\",\n        \"city\": {\n          \"code\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"cityName\": \"<string>\"\n      }\n    },\n    \"volumeQuantity\": 123,\n    \"volumeNumeration\": \"<string>\",\n    \"species\": \"<string>\",\n    \"brand\": \"<string>\",\n    \"grossWeight\": 123,\n    \"netWeight\": 123\n  },\n  \"warrantyDate\": \"2023-11-07T05:31:56Z\",\n  \"sendEmailToCustomer\": true,\n  \"invoices\": [\n    {\n      \"issuedOn\": \"2023-11-07T05:31:56Z\",\n      \"receiver\": {\n        \"name\": \"<string>\",\n        \"federalTaxNumber\": \"<string>\",\n        \"stateTaxNumber\": \"<string>\",\n        \"suframaTaxNumber\": \"<string>\",\n        \"cityTaxNumber\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phoneNumber\": \"<string>\",\n        \"address\": {\n          \"street\": \"<string>\",\n          \"district\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"number\": \"<string>\",\n          \"additionalInformation\": \"<string>\",\n          \"city\": {\n            \"name\": \"<string>\",\n            \"state\": \"<string>\",\n            \"code\": 123\n          },\n          \"country\": \"<string>\"\n        }\n      },\n      \"additionalInformation\": \"<string>\",\n      \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n      \"number\": 123\n    }\n  ],\n  \"event\": {\n    \"name\": \"<string>\",\n    \"startDate\": \"2023-11-07T05:31:56Z\",\n    \"endDate\": \"2023-11-07T05:31:56Z\",\n    \"identifier\": \"<string>\",\n    \"address\": {\n      \"street\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"number\": \"<string>\",\n      \"additionalInformation\": \"<string>\",\n      \"city\": {\n        \"name\": \"<string>\",\n        \"state\": \"<string>\",\n        \"code\": 123\n      },\n      \"country\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spedy.com.br/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"amount\": 123,\n  \"date\": \"2023-11-07T05:31:56Z\",\n  \"items\": [\n    {\n      \"quantity\": 123,\n      \"price\": 123,\n      \"amount\": 123,\n      \"product\": {\n        \"name\": \"<string>\",\n        \"code\": \"<string>\",\n        \"price\": 123\n      },\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"freightAmount\": 123\n    }\n  ],\n  \"transactionId\": \"<string>\",\n  \"discountAmount\": 123,\n  \"freightAmount\": 123,\n  \"freight\": {\n    \"carrier\": {\n      \"name\": \"<string>\",\n      \"legalName\": \"<string>\",\n      \"federalTaxNumber\": \"<string>\",\n      \"cityTaxNumber\": \"<string>\",\n      \"stateTaxNumber\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"mobilePhone\": \"<string>\",\n      \"address\": {\n        \"street\": \"<string>\",\n        \"district\": \"<string>\",\n        \"postalCode\": \"<string>\",\n        \"number\": \"<string>\",\n        \"additionalInformation\": \"<string>\",\n        \"city\": {\n          \"code\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"cityName\": \"<string>\"\n      }\n    },\n    \"volumeQuantity\": 123,\n    \"volumeNumeration\": \"<string>\",\n    \"species\": \"<string>\",\n    \"brand\": \"<string>\",\n    \"grossWeight\": 123,\n    \"netWeight\": 123\n  },\n  \"warrantyDate\": \"2023-11-07T05:31:56Z\",\n  \"sendEmailToCustomer\": true,\n  \"invoices\": [\n    {\n      \"issuedOn\": \"2023-11-07T05:31:56Z\",\n      \"receiver\": {\n        \"name\": \"<string>\",\n        \"federalTaxNumber\": \"<string>\",\n        \"stateTaxNumber\": \"<string>\",\n        \"suframaTaxNumber\": \"<string>\",\n        \"cityTaxNumber\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phoneNumber\": \"<string>\",\n        \"address\": {\n          \"street\": \"<string>\",\n          \"district\": \"<string>\",\n          \"postalCode\": \"<string>\",\n          \"number\": \"<string>\",\n          \"additionalInformation\": \"<string>\",\n          \"city\": {\n            \"name\": \"<string>\",\n            \"state\": \"<string>\",\n            \"code\": 123\n          },\n          \"country\": \"<string>\"\n        }\n      },\n      \"additionalInformation\": \"<string>\",\n      \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n      \"number\": 123\n    }\n  ],\n  \"event\": {\n    \"name\": \"<string>\",\n    \"startDate\": \"2023-11-07T05:31:56Z\",\n    \"endDate\": \"2023-11-07T05:31:56Z\",\n    \"identifier\": \"<string>\",\n    \"address\": {\n      \"street\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"number\": \"<string>\",\n      \"additionalInformation\": \"<string>\",\n      \"city\": {\n        \"name\": \"<string>\",\n        \"state\": \"<string>\",\n        \"code\": 123\n      },\n      \"country\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactionId": "<string>",
  "date": "2023-11-07T05:31:56Z",
  "customer": {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "legalName": "<string>",
    "federalTaxNumber": "<string>",
    "cityTaxNumber": "<string>",
    "stateTaxNumber": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "mobilePhone": "<string>",
    "address": {
      "street": "<string>",
      "district": "<string>",
      "postalCode": "<string>",
      "number": "<string>",
      "additionalInformation": "<string>",
      "city": {
        "code": "<string>",
        "name": "<string>"
      },
      "country": {
        "name": "<string>",
        "code": 123
      },
      "cityName": "<string>"
    }
  },
  "amount": 123,
  "items": [
    {
      "quantity": 123,
      "price": 123,
      "amount": 123,
      "product": {
        "name": "<string>",
        "code": "<string>",
        "price": 123
      },
      "description": "<string>",
      "discountAmount": 123,
      "freightAmount": 123
    }
  ],
  "invoices": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "processingDetail": {
        "message": "<string>",
        "code": "<string>",
        "on": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

X-Api-Key

string

header

required

Authorization By X-Api-Key inside request's header

Body

amount

number<double>

required

Valor total da venda

date

string<date-time>

required

Data da venda

items

object[]

required

Itens da venda

Show child attributes

transactionId

string | null

Código da Transação / Venda

customer

object

Show child attributes

discountAmount

number<double>

Valor total de desconto

freightAmount

number<double> | null

Valor total de frete

freight

object

Transportadora e dados de transporte da venda

Show child attributes

warrantyDate

string<date-time> | null

Data da Garantia

sendEmailToCustomer

boolean | null

Enviar e-mail para cliente

status

enum<string>

Situação da venda

Valores possíveis:

created: Criado
awaitingPayment: Aguardando pagamento
approved: Aprovado
refundRequested: Reembolso solicitado
completed: Concluído
chargeback: Chargeback
canceled: Cancelado
refunded: Reembolsado
expired: Vencido
refused: Recusado
deleted: Deletado

Available options:

created,

awaitingPayment,

approved,

refundRequested,

completed,

chargeback,

canceled,

refunded,

expired,

refused,

deleted

autoIssueMode

enum<string>

Valores possíveis:

disabled: Desativado (Manual)
immediately: Imediatamente (default)
afterPayment: Após o pagamento
afterWarrency: Após a garantia

Available options:

disabled,

immediately,

afterPayment,

afterWarrency

paymentMethod

enum<string>

Forma de pagamento

Valores possíveis:

billetBank: Boleto
creditCard: Cartão de Crédito
debitCard: Cartão de Débito
pix: PIX
paypal: Paypal
bankTransfer: Transferência Bancária
balanceWallets: Saldo da Carteira
other: Outro
cash: Dinheiro

Available options:

billetBank,

creditCard,

debitCard,

pix,

paypal,

bankTransfer,

balanceWallets,

other,

cash

profileType

enum<string>

Tipo do Perfil

Valores possíveis:

producer: Produtor
coproducer: Coprodutor
affiliate: Afiliado

Available options:

producer,

coproducer,

affiliate

invoices

object[] | null

Notas fiscais (Opcional). Informar somente quando necessário personalizar alguma informação da NF a ser gerada.

Show child attributes

event

object

Show child attributes

Response

Success

string<uuid>

ID da Venda

transactionId

string | null

Código da Transação

date

string<date-time>

Data da Venda

customer

object

Show child attributes

amount

number<double>

Valor total

status

enum<string>

Situação da venda

Valores possíveis:

created: Criado
awaitingPayment: Aguardando pagamento
approved: Aprovado
refundRequested: Reembolso solicitado
completed: Concluído
chargeback: Chargeback
canceled: Cancelado
refunded: Reembolsado
expired: Vencido
refused: Recusado
deleted: Deletado

Available options:

created,

awaitingPayment,

approved,

refundRequested,

completed,

chargeback,

canceled,

refunded,

expired,

refused,

deleted

sourcePlatform

enum<string>

Plataforma de venda integrada

Valores possíveis:

spedy: Spedy
hotmart: Hotmart
monetizze: Monetizze
eduzz: Eduzz
braip: Braip
shopify: Shopify
iugu: Iugu
pagarme: Pagar.me
kiwify: Kiwify
mercadoPago: Mercado Pago
yampi: Yampi
nuvemshop: Nuvemshop
cartpanda: Cartpanda
stripe: Stripe
perfectPay: PerfectPay
evermart: Evermart
cyclopay: Cyclopay
greenn: Greenn
woocommerce: WooCommerce
afiliaPay: AfiliaPay
blueticket: Blueticket
abmex: Abmex
asaas: Asaas
doppus: Doppus
dooca: Dooca
vindi: Vindi
guru: Guru
ticto: Ticto
eADPlataforma: EAD Plataforma
provi: Provi
blitzPay: BlitzPay
payt: Payt
eventiza: Eventiza
pepper: Pepper
appMax: AppMax
voomp: Voomp
xgrow: Xgrow
kirvano: Kirvano
theMart: The Mart
hubla: Hubla
payPal: PayPal
tMB: TMB
lastlink: Lastlink
vega: Vega
doppusV2: Doppus V2
cakto: Cakto
wix: Wix
wBuy: WBuy
pepperV2: Pepper V2
neonPay: NeonPay
assiny: Assiny
pagTrust: PagTrust
wiapy: Wiapy
onProfit: OnProfit
edunext: Edunext
yampiV2: Yampi V2
yever: Yever
tikTokShop: TikTok Shop
luna: Luna
bilion: Bilion
shopee: Shopee
b4you: B4you
vegaV2: Vega V2
domPagamentos: Dom Pagamentos
neofin: Neofin
pagBank: PagBank
lia: Lia
yuno: Yuno
theMembers: The Members
digistore24: Digistore24
heroSpark: HeroSpark
woovi: Woovi
zouti: Zouti
eduzzV4: EduzzV4
stripeV2: StripeV2
shopeeAffiliate: Shopee Afiliados
firePay: FirePay

Available options:

spedy,

hotmart,

monetizze,

eduzz,

braip,

shopify,

iugu,

pagarme,

kiwify,

mercadoPago,

yampi,

nuvemshop,

cartpanda,

stripe,

perfectPay,

evermart,

cyclopay,

greenn,

woocommerce,

afiliaPay,

blueticket,

abmex,

asaas,

doppus,

dooca,

vindi,

guru,

ticto,

eadPlataforma,

provi,

blitzPay,

payt,

eventiza,

pepper,

appMax,

voomp,

xgrow,

kirvano,

theMart,

hubla,

payPal,

tmb,

lastlink,

vega,

doppusV2,

cakto,

wix,

wBuy,

pepperV2,

neonPay,

assiny,

pagTrust,

wiapy,

onProfit,

edunext,

yampiV2,

yever,

tikTokShop,

luna,

bilion,

shopee,

b4you,

vegaV2,

domPagamentos,

neofin,

pagBank,

lia,

yuno,

theMembers,

digistore24,

heroSpark,

woovi,

zouti,

eduzzV4,

stripeV2,

shopeeAffiliate,

firePay

items

object[] | null

Items da venda

Show child attributes

autoIssueMode

enum<string>

Valores possíveis:

disabled: Desativado (Manual)
immediately: Imediatamente (default)
afterPayment: Após o pagamento
afterWarrency: Após a garantia

Available options:

disabled,

immediately,

afterPayment,

afterWarrency

paymentMethod

enum<string>

Forma de pagamento

Valores possíveis:

billetBank: Boleto
creditCard: Cartão de Crédito
debitCard: Cartão de Débito
pix: PIX
paypal: Paypal
bankTransfer: Transferência Bancária
balanceWallets: Saldo da Carteira
other: Outro
cash: Dinheiro

Available options:

billetBank,

creditCard,

debitCard,

pix,

paypal,

bankTransfer,

balanceWallets,

other,

cash

invoices

object[] | null

Notas fiscais

Show child attributes

⌘I

Visão geral

Endpoints

Criar Venda

Authorizations

Body

Response