Filter shipping methods
curl --request POST \
--url https://prod01.oms.fabric.inc/api/v2/shipping/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-site-context: <x-site-context>' \
--data '
{
"sortBy": "createdBy",
"filters": {
"name": "UPS",
"description": "UPS for 2-5 days",
"deleted": "false",
"addressType": [
"APO"
],
"createdAt": {
"lt": "2022-09-11T23:12:00.123Z"
},
"createdBy": "USER-1"
},
"limit": 10,
"offset": 0,
"sortDirection": "desc"
}
'import requests
url = "https://prod01.oms.fabric.inc/api/v2/shipping/query"
payload = {
"sortBy": "createdBy",
"filters": {
"name": "UPS",
"description": "UPS for 2-5 days",
"deleted": "false",
"addressType": ["APO"],
"createdAt": { "lt": "2022-09-11T23:12:00.123Z" },
"createdBy": "USER-1"
},
"limit": 10,
"offset": 0,
"sortDirection": "desc"
}
headers = {
"x-site-context": "<x-site-context>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-site-context': '<x-site-context>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sortBy: 'createdBy',
filters: {
name: 'UPS',
description: 'UPS for 2-5 days',
deleted: 'false',
addressType: ['APO'],
createdAt: {lt: '2022-09-11T23:12:00.123Z'},
createdBy: 'USER-1'
},
limit: 10,
offset: 0,
sortDirection: 'desc'
})
};
fetch('https://prod01.oms.fabric.inc/api/v2/shipping/query', 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://prod01.oms.fabric.inc/api/v2/shipping/query",
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([
'sortBy' => 'createdBy',
'filters' => [
'name' => 'UPS',
'description' => 'UPS for 2-5 days',
'deleted' => 'false',
'addressType' => [
'APO'
],
'createdAt' => [
'lt' => '2022-09-11T23:12:00.123Z'
],
'createdBy' => 'USER-1'
],
'limit' => 10,
'offset' => 0,
'sortDirection' => 'desc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-site-context: <x-site-context>"
],
]);
$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://prod01.oms.fabric.inc/api/v2/shipping/query"
payload := strings.NewReader("{\n \"sortBy\": \"createdBy\",\n \"filters\": {\n \"name\": \"UPS\",\n \"description\": \"UPS for 2-5 days\",\n \"deleted\": \"false\",\n \"addressType\": [\n \"APO\"\n ],\n \"createdAt\": {\n \"lt\": \"2022-09-11T23:12:00.123Z\"\n },\n \"createdBy\": \"USER-1\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"sortDirection\": \"desc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-site-context", "<x-site-context>")
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://prod01.oms.fabric.inc/api/v2/shipping/query")
.header("x-site-context", "<x-site-context>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sortBy\": \"createdBy\",\n \"filters\": {\n \"name\": \"UPS\",\n \"description\": \"UPS for 2-5 days\",\n \"deleted\": \"false\",\n \"addressType\": [\n \"APO\"\n ],\n \"createdAt\": {\n \"lt\": \"2022-09-11T23:12:00.123Z\"\n },\n \"createdBy\": \"USER-1\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"sortDirection\": \"desc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod01.oms.fabric.inc/api/v2/shipping/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sortBy\": \"createdBy\",\n \"filters\": {\n \"name\": \"UPS\",\n \"description\": \"UPS for 2-5 days\",\n \"deleted\": \"false\",\n \"addressType\": [\n \"APO\"\n ],\n \"createdAt\": {\n \"lt\": \"2022-09-11T23:12:00.123Z\"\n },\n \"createdBy\": \"USER-1\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"sortDirection\": \"desc\"\n}"
response = http.request(request)
puts response.read_body{
"count": 100,
"limit": 10,
"offset": 1
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Shipping Method
Filter shipping methods
Gets shipping method by specified filter criteria.
POST
/
shipping
/
query
Filter shipping methods
curl --request POST \
--url https://prod01.oms.fabric.inc/api/v2/shipping/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-site-context: <x-site-context>' \
--data '
{
"sortBy": "createdBy",
"filters": {
"name": "UPS",
"description": "UPS for 2-5 days",
"deleted": "false",
"addressType": [
"APO"
],
"createdAt": {
"lt": "2022-09-11T23:12:00.123Z"
},
"createdBy": "USER-1"
},
"limit": 10,
"offset": 0,
"sortDirection": "desc"
}
'import requests
url = "https://prod01.oms.fabric.inc/api/v2/shipping/query"
payload = {
"sortBy": "createdBy",
"filters": {
"name": "UPS",
"description": "UPS for 2-5 days",
"deleted": "false",
"addressType": ["APO"],
"createdAt": { "lt": "2022-09-11T23:12:00.123Z" },
"createdBy": "USER-1"
},
"limit": 10,
"offset": 0,
"sortDirection": "desc"
}
headers = {
"x-site-context": "<x-site-context>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-site-context': '<x-site-context>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sortBy: 'createdBy',
filters: {
name: 'UPS',
description: 'UPS for 2-5 days',
deleted: 'false',
addressType: ['APO'],
createdAt: {lt: '2022-09-11T23:12:00.123Z'},
createdBy: 'USER-1'
},
limit: 10,
offset: 0,
sortDirection: 'desc'
})
};
fetch('https://prod01.oms.fabric.inc/api/v2/shipping/query', 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://prod01.oms.fabric.inc/api/v2/shipping/query",
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([
'sortBy' => 'createdBy',
'filters' => [
'name' => 'UPS',
'description' => 'UPS for 2-5 days',
'deleted' => 'false',
'addressType' => [
'APO'
],
'createdAt' => [
'lt' => '2022-09-11T23:12:00.123Z'
],
'createdBy' => 'USER-1'
],
'limit' => 10,
'offset' => 0,
'sortDirection' => 'desc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-site-context: <x-site-context>"
],
]);
$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://prod01.oms.fabric.inc/api/v2/shipping/query"
payload := strings.NewReader("{\n \"sortBy\": \"createdBy\",\n \"filters\": {\n \"name\": \"UPS\",\n \"description\": \"UPS for 2-5 days\",\n \"deleted\": \"false\",\n \"addressType\": [\n \"APO\"\n ],\n \"createdAt\": {\n \"lt\": \"2022-09-11T23:12:00.123Z\"\n },\n \"createdBy\": \"USER-1\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"sortDirection\": \"desc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-site-context", "<x-site-context>")
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://prod01.oms.fabric.inc/api/v2/shipping/query")
.header("x-site-context", "<x-site-context>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sortBy\": \"createdBy\",\n \"filters\": {\n \"name\": \"UPS\",\n \"description\": \"UPS for 2-5 days\",\n \"deleted\": \"false\",\n \"addressType\": [\n \"APO\"\n ],\n \"createdAt\": {\n \"lt\": \"2022-09-11T23:12:00.123Z\"\n },\n \"createdBy\": \"USER-1\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"sortDirection\": \"desc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod01.oms.fabric.inc/api/v2/shipping/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sortBy\": \"createdBy\",\n \"filters\": {\n \"name\": \"UPS\",\n \"description\": \"UPS for 2-5 days\",\n \"deleted\": \"false\",\n \"addressType\": [\n \"APO\"\n ],\n \"createdAt\": {\n \"lt\": \"2022-09-11T23:12:00.123Z\"\n },\n \"createdBy\": \"USER-1\"\n },\n \"limit\": 10,\n \"offset\": 0,\n \"sortDirection\": \"desc\"\n}"
response = http.request(request)
puts response.read_body{
"count": 100,
"limit": 10,
"offset": 1
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.
Example:
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
Body
application/json
Filter criteria
Sorting criteria
Example:
"createdBy"
Show child attributes
Show child attributes
Example:
{
"name": "UPS",
"description": "UPS for 2-5 days",
"deleted": "false",
"addressType": ["APO"],
"createdAt": { "lt": "2022-09-11T23:12:00.123Z" },
"createdBy": "USER-1"
}
Ending record number (from the offset number) in the response. When no value is provided, the default value is 10.
Example:
10
Starting number of the record (within the total number of records) in the response. Offset is zero-based. That is, the 10th record is at offset 9 starting from the 0th record. When no value is provided, the default value is 0
Example:
0
Sorting direction - ascending or descending
Available options:
asc, desc Example:
"desc"
Response
OK
Pagination details
Total number of records
Example:
100
Ending record number (from the offset number) in the response. When no value is provided, the default value is 10
Example:
10
Starting number of the record (within the total number of records) in the response. Offset is zero-based. That is, the 10th record is at offset 9 starting from the 0th record. When no value is provided, the default value is 0
Example:
1
Was this page helpful?