Skip to main content
POST
/
api
/
ext
/
v1
/
collection
/
{collectionId}
/
orders
Place Order
curl --request POST \
  --url https://staging-api.covver.io/api/ext/v1/collection/{collectionId}/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>"
  },
  "orderItems": [
    {
      "variantId": "<string>",
      "quantity": 123
    }
  ],
  "address": {
    "address1": "<string>",
    "city": "<string>",
    "countryCode": "<string>",
    "phone": "<string>",
    "address2": "",
    "province": "<string>",
    "provinceCode": "<string>",
    "customAttributes": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "zip": "",
    "country": "<string>"
  },
  "companyId": "<string>",
  "isVip": true,
  "taxNumber": "<string>",
  "customAttributes": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "note": "<string>",
  "personalizations": {
    "firstName": "<string>",
    "lastName": "<string>",
    "department": "<string>",
    "location": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "birthDate": "2023-11-07T05:31:56Z"
  },
  "externalId": "<string>",
  "shouldSendEmail": true,
  "shouldValidateProvinceCode": true
}
'
import requests

url = "https://staging-api.covver.io/api/ext/v1/collection/{collectionId}/orders"

payload = {
    "user": {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>"
    },
    "orderItems": [
        {
            "variantId": "<string>",
            "quantity": 123
        }
    ],
    "address": {
        "address1": "<string>",
        "city": "<string>",
        "countryCode": "<string>",
        "phone": "<string>",
        "address2": "",
        "province": "<string>",
        "provinceCode": "<string>",
        "customAttributes": [
            {
                "key": "<string>",
                "value": "<string>"
            }
        ],
        "zip": "",
        "country": "<string>"
    },
    "companyId": "<string>",
    "isVip": True,
    "taxNumber": "<string>",
    "customAttributes": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "note": "<string>",
    "personalizations": {
        "firstName": "<string>",
        "lastName": "<string>",
        "department": "<string>",
        "location": "<string>",
        "startDate": "2023-11-07T05:31:56Z",
        "birthDate": "2023-11-07T05:31:56Z"
    },
    "externalId": "<string>",
    "shouldSendEmail": True,
    "shouldValidateProvinceCode": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    user: {firstName: '<string>', lastName: '<string>', email: '<string>'},
    orderItems: [{variantId: '<string>', quantity: 123}],
    address: {
      address1: '<string>',
      city: '<string>',
      countryCode: '<string>',
      phone: '<string>',
      address2: '',
      province: '<string>',
      provinceCode: '<string>',
      customAttributes: [{key: '<string>', value: '<string>'}],
      zip: '',
      country: '<string>'
    },
    companyId: '<string>',
    isVip: true,
    taxNumber: '<string>',
    customAttributes: [{key: '<string>', value: '<string>'}],
    note: '<string>',
    personalizations: {
      firstName: '<string>',
      lastName: '<string>',
      department: '<string>',
      location: '<string>',
      startDate: '2023-11-07T05:31:56Z',
      birthDate: '2023-11-07T05:31:56Z'
    },
    externalId: '<string>',
    shouldSendEmail: true,
    shouldValidateProvinceCode: true
  })
};

fetch('https://staging-api.covver.io/api/ext/v1/collection/{collectionId}/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://staging-api.covver.io/api/ext/v1/collection/{collectionId}/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([
    'user' => [
        'firstName' => '<string>',
        'lastName' => '<string>',
        'email' => '<string>'
    ],
    'orderItems' => [
        [
                'variantId' => '<string>',
                'quantity' => 123
        ]
    ],
    'address' => [
        'address1' => '<string>',
        'city' => '<string>',
        'countryCode' => '<string>',
        'phone' => '<string>',
        'address2' => '',
        'province' => '<string>',
        'provinceCode' => '<string>',
        'customAttributes' => [
                [
                                'key' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'zip' => '',
        'country' => '<string>'
    ],
    'companyId' => '<string>',
    'isVip' => true,
    'taxNumber' => '<string>',
    'customAttributes' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'note' => '<string>',
    'personalizations' => [
        'firstName' => '<string>',
        'lastName' => '<string>',
        'department' => '<string>',
        'location' => '<string>',
        'startDate' => '2023-11-07T05:31:56Z',
        'birthDate' => '2023-11-07T05:31:56Z'
    ],
    'externalId' => '<string>',
    'shouldSendEmail' => true,
    'shouldValidateProvinceCode' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://staging-api.covver.io/api/ext/v1/collection/{collectionId}/orders"

	payload := strings.NewReader("{\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"orderItems\": [\n    {\n      \"variantId\": \"<string>\",\n      \"quantity\": 123\n    }\n  ],\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"countryCode\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"address2\": \"\",\n    \"province\": \"<string>\",\n    \"provinceCode\": \"<string>\",\n    \"customAttributes\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"zip\": \"\",\n    \"country\": \"<string>\"\n  },\n  \"companyId\": \"<string>\",\n  \"isVip\": true,\n  \"taxNumber\": \"<string>\",\n  \"customAttributes\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"note\": \"<string>\",\n  \"personalizations\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"department\": \"<string>\",\n    \"location\": \"<string>\",\n    \"startDate\": \"2023-11-07T05:31:56Z\",\n    \"birthDate\": \"2023-11-07T05:31:56Z\"\n  },\n  \"externalId\": \"<string>\",\n  \"shouldSendEmail\": true,\n  \"shouldValidateProvinceCode\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/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://staging-api.covver.io/api/ext/v1/collection/{collectionId}/orders")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"orderItems\": [\n    {\n      \"variantId\": \"<string>\",\n      \"quantity\": 123\n    }\n  ],\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"countryCode\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"address2\": \"\",\n    \"province\": \"<string>\",\n    \"provinceCode\": \"<string>\",\n    \"customAttributes\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"zip\": \"\",\n    \"country\": \"<string>\"\n  },\n  \"companyId\": \"<string>\",\n  \"isVip\": true,\n  \"taxNumber\": \"<string>\",\n  \"customAttributes\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"note\": \"<string>\",\n  \"personalizations\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"department\": \"<string>\",\n    \"location\": \"<string>\",\n    \"startDate\": \"2023-11-07T05:31:56Z\",\n    \"birthDate\": \"2023-11-07T05:31:56Z\"\n  },\n  \"externalId\": \"<string>\",\n  \"shouldSendEmail\": true,\n  \"shouldValidateProvinceCode\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.covver.io/api/ext/v1/collection/{collectionId}/orders")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"orderItems\": [\n    {\n      \"variantId\": \"<string>\",\n      \"quantity\": 123\n    }\n  ],\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"countryCode\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"address2\": \"\",\n    \"province\": \"<string>\",\n    \"provinceCode\": \"<string>\",\n    \"customAttributes\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"zip\": \"\",\n    \"country\": \"<string>\"\n  },\n  \"companyId\": \"<string>\",\n  \"isVip\": true,\n  \"taxNumber\": \"<string>\",\n  \"customAttributes\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"note\": \"<string>\",\n  \"personalizations\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"department\": \"<string>\",\n    \"location\": \"<string>\",\n    \"startDate\": \"2023-11-07T05:31:56Z\",\n    \"birthDate\": \"2023-11-07T05:31:56Z\"\n  },\n  \"externalId\": \"<string>\",\n  \"shouldSendEmail\": true,\n  \"shouldValidateProvinceCode\": true\n}"

response = http.request(request)
puts response.read_body
{
  "order": {
    "id": "<string>",
    "orderNumber": "<string>"
  }
}
{
  "message": "<string>",
  "errorCode": "<string>",
  "statusCode": 123,
  "error": "<unknown>"
}
{
  "message": "<string>",
  "errorCode": "<string>",
  "statusCode": 123,
  "error": "<unknown>"
}
See List of countries
Pass in the user’s details for personalized items. See personalization guide for more details
Partners must pass in the companyId field in the body

​
International pricing

NOTE! Some products have a priceDeltaByCountry field that will affect the price of the product when shipped internationally. If you pass countryCode when getting the product you will get the price after applying the delta. If you don’t pass countryCode you should apply the delta yourself based on the recipient’s address

​
Tax number

For Brazil, Mexico, China, Italy, and South Korea you must pass in an additional taxNumber field. For Brazil the tax number field must pass regex validation as follows 
new RegExp(`^\\d{3}\\.\\d{3}\\.\\d{3}-\\d{2}$`).test(taxNumber)
For Mexico the pattern is 13 characters (4 letters followed by 6 digits and 3 alphanumeric characters). 
new RegExp(`^[A-Za-z]{4}\\d{6}[A-Za-z0-9]{3}$`).test(taxNumber)
For China, Italy, and South Korea there is no validation run on the taxNumber field.

​
Personalization

To order a product with personalization the personalized product must first be created via the getProduct or listProducts endpoints

​
CustomAttributes

Custom attribute field is deprecated. Please use the taxNumber field instead

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
collectionId
string<uuid>
required

Body

application/json
​
user
object
required
​
orderItems
object[]
required
​
address
object
required
​
companyId
string

Required for partners

​
isVip
boolean
​
taxNumber
string
​
customAttributes
object[]
​
note
string
​
personalizations
object
​
externalId
string
​
shouldSendEmail
boolean
default:true
​
shouldValidateProvinceCode
boolean

Response

Default Response

​
order
object
required