List orders - Velocity for BigCommerce API Docs

List orders

curl --request GET \
  --url https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/ \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant}.api.velocity.medshift.com/integrations/zapier/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://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bigcommerce_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "is_external": true,
    "is_archived": true,
    "archived_at": "2023-11-07T05:31:56Z",
    "customer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bigcommerce_id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "company_name": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>"
    },
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "jsmith@example.com",
      "picture": "<string>"
    },
    "bigcommerce_status": "<string>",
    "is_approved": true,
    "approved_at": "2023-11-07T05:31:56Z",
    "approved_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "jsmith@example.com",
      "picture": "<string>"
    },
    "subtotal_price": "<string>",
    "shipping_price": "0.00",
    "handling_price": "0.00",
    "tax_price": "<string>",
    "discount_price": "0.00",
    "total_price": "<string>",
    "store_credit": "<string>",
    "payment": {
      "online": {
        "stripe_payment_intent_id": "<string>"
      },
      "terms": {
        "due_date": "2023-12-25",
        "is_capital": true,
        "outstanding_balance": "<string>"
      }
    },
    "coupons": [
      {
        "bigcommerce_coupon_id": 123,
        "code": "<string>",
        "discount_price": "<string>"
      }
    ],
    "is_digital": true,
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bigcommerce_id": 123,
        "name": "<string>",
        "sku": "<string>",
        "type": "<string>",
        "quantity": 500000,
        "unit_price": "<string>",
        "total_price": "<string>",
        "tax_price": "<string>",
        "subtotal_price": "<string>",
        "total_tax_price": "<string>",
        "discount_price": "<string>",
        "options": [
          {
            "display_name": "<string>",
            "display_value": "<string>"
          }
        ]
      }
    ],
    "billing_address": {
      "first_name": "<string>",
      "last_name": "<string>",
      "street_1": "<string>",
      "city": "<string>",
      "country_iso2": "<string>",
      "company": "",
      "phone": "",
      "street_2": "",
      "state_province": "",
      "postal_code": ""
    },
    "shipping_address": {
      "first_name": "<string>",
      "last_name": "<string>",
      "street_1": "<string>",
      "city": "<string>",
      "country_iso2": "<string>",
      "company": "",
      "phone": "",
      "street_2": "",
      "state_province": "",
      "postal_code": ""
    },
    "shipping_method": "<string>",
    "subscription": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "customer_notes": "<string>",
    "staff_notes": "<string>",
    "custom_fields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "value": null
      }
    ]
  }
]

Authorizations

X-API-Key

string

header

required

Query Parameters

bigcommerce_id

number

custom_fields

string

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

ordering

string

Which field to use when ordering the results.

Response

200 - application/json

string<uuid>

required

read-only

bigcommerce_id

integer

required

read-only

created_at

string<date-time>

required

read-only

is_external

boolean

required

read-only

is_archived

boolean

required

read-only

archived_at

string<date-time>

required

read-only

customer

object

required

Show child attributes

created_by

object

required

Show child attributes

bigcommerce_status

string

required

read-only

is_approved

boolean

required

read-only

approved_at

string<date-time>

required

read-only

approved_by

object

required

Show child attributes

subtotal_price

string<decimal>

required

read-only

The total cost of line items before discounts or tax.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

shipping_price

string<decimal>

default:0.00

required

read-only

The cost of shipping before tax.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

handling_price

string<decimal>

default:0.00

required

read-only

The cost of handling before tax.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

tax_price

string<decimal>

required

read-only

The total amount of tax.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

discount_price

string<decimal>

default:0.00

required

read-only

The total amount of discounts.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

total_price

string<decimal>

required

read-only

The total cost of the order, less store credit.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

store_credit

string<decimal>

required

read-only

The amount of store credit applied.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

payment

object

required

Show child attributes

coupons

object[]

required

read-only

Show child attributes

is_digital

boolean

required

read-only

If the order contains no physical (shippable) products.

line_items

object[]

required

read-only

Show child attributes

billing_address

object

required

Show child attributes

shipping_address

object | null

required

Show child attributes

shipping_method

string | null

required

read-only

Maximum string length: 250

subscription

object

required

Show child attributes

bigcommerce_status_id

enum<integer>

0 - Incomplete
1 - Pending
2 - Shipped
3 - Partially Shipped
4 - Refunded
5 - Cancelled
6 - Declined
7 - Awaiting Payment
8 - Awaiting Pickup
9 - Awaiting Shipment
10 - Completed
11 - Awaiting Fulfillment
12 - Manual Verification Required
13 - Disputed
14 - Partially Refunded

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

13,

14

customer_notes

string

Maximum string length: 65535

staff_notes

string

Maximum string length: 65535

custom_fields

object[]

Show child attributes

List orders

curl --request GET \
  --url https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/ \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant}.api.velocity.medshift.com/integrations/zapier/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://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{tenant}.api.velocity.medshift.com/integrations/zapier/v1/orders/")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bigcommerce_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "is_external": true,
    "is_archived": true,
    "archived_at": "2023-11-07T05:31:56Z",
    "customer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bigcommerce_id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "company_name": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>"
    },
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "jsmith@example.com",
      "picture": "<string>"
    },
    "bigcommerce_status": "<string>",
    "is_approved": true,
    "approved_at": "2023-11-07T05:31:56Z",
    "approved_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "jsmith@example.com",
      "picture": "<string>"
    },
    "subtotal_price": "<string>",
    "shipping_price": "0.00",
    "handling_price": "0.00",
    "tax_price": "<string>",
    "discount_price": "0.00",
    "total_price": "<string>",
    "store_credit": "<string>",
    "payment": {
      "online": {
        "stripe_payment_intent_id": "<string>"
      },
      "terms": {
        "due_date": "2023-12-25",
        "is_capital": true,
        "outstanding_balance": "<string>"
      }
    },
    "coupons": [
      {
        "bigcommerce_coupon_id": 123,
        "code": "<string>",
        "discount_price": "<string>"
      }
    ],
    "is_digital": true,
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bigcommerce_id": 123,
        "name": "<string>",
        "sku": "<string>",
        "type": "<string>",
        "quantity": 500000,
        "unit_price": "<string>",
        "total_price": "<string>",
        "tax_price": "<string>",
        "subtotal_price": "<string>",
        "total_tax_price": "<string>",
        "discount_price": "<string>",
        "options": [
          {
            "display_name": "<string>",
            "display_value": "<string>"
          }
        ]
      }
    ],
    "billing_address": {
      "first_name": "<string>",
      "last_name": "<string>",
      "street_1": "<string>",
      "city": "<string>",
      "country_iso2": "<string>",
      "company": "",
      "phone": "",
      "street_2": "",
      "state_province": "",
      "postal_code": ""
    },
    "shipping_address": {
      "first_name": "<string>",
      "last_name": "<string>",
      "street_1": "<string>",
      "city": "<string>",
      "country_iso2": "<string>",
      "company": "",
      "phone": "",
      "street_2": "",
      "state_province": "",
      "postal_code": ""
    },
    "shipping_method": "<string>",
    "subscription": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "customer_notes": "<string>",
    "staff_notes": "<string>",
    "custom_fields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "value": null
      }
    ]
  }
]