List order refunds - Velocity for BigCommerce API Docs

List order refunds

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

import requests

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

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/order_refunds/', 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/order_refunds/",
  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/order_refunds/"

	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/order_refunds/")

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,
    "order": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bigcommerce_id": 123
    },
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "jsmith@example.com",
      "picture": "<string>"
    },
    "notes": "<string>",
    "total_amount": "<string>",
    "tax_amount": "<string>",
    "items": [
      {
        "amount": "<string>",
        "line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "quantity": 123
      }
    ]
  }
]

Authorizations

X-API-Key

string

header

required

Query Parameters

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

Response

200 - application/json

id

string<uuid>

required

bigcommerce_id

integer

required

order

object

required

Show child attributes

created_at

string<date-time>

required

created_by

object | null

required

Show child attributes

reason

enum<string>

required

requested_by_customer - requested_by_customer
fraudulent - fraudulent
duplicate - duplicate
other - other

Available options:

requested_by_customer,

fraudulent,

duplicate,

other

status

enum<string>

required

succeeded - succeeded
pending - pending
failed - failed

Available options:

succeeded,

pending,

failed

notes

string

required

Minimum string length: 1

total_amount

string<decimal>

required

The total amount refunded, including tax.

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

tax_amount

string<decimal>

required

The amount of tax refunded.

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

items

object[]

required

Show child attributes

List order refunds

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

import requests

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

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/order_refunds/', 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/order_refunds/",
  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/order_refunds/"

	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/order_refunds/")

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,
    "order": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bigcommerce_id": 123
    },
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "jsmith@example.com",
      "picture": "<string>"
    },
    "notes": "<string>",
    "total_amount": "<string>",
    "tax_amount": "<string>",
    "items": [
      {
        "amount": "<string>",
        "line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "quantity": 123
      }
    ]
  }
]