Skip to main content
POST
/
shipping-methods
/
search
Find shipping methods
curl --request POST \
  --url https://api.fabric.inc/v3/shipping-methods/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "filters": [
    {
      "condition": "EQ",
      "field": "shippingMethod.addressType",
      "value": "APO"
    },
    {
      "condition": "IN",
      "field": "shippingMethod.maximumDays",
      "values": [
        10,
        20
      ]
    }
  ],
  "sort": "-shippingMethod.createdAt"
}
'
import requests

url = "https://api.fabric.inc/v3/shipping-methods/search"

payload = {
    "filters": [
        {
            "condition": "EQ",
            "field": "shippingMethod.addressType",
            "value": "APO"
        },
        {
            "condition": "IN",
            "field": "shippingMethod.maximumDays",
            "values": [10, 20]
        }
    ],
    "sort": "-shippingMethod.createdAt"
}
headers = {
    "x-fabric-tenant-id": "<x-fabric-tenant-id>",
    "x-fabric-channel-id": "<x-fabric-channel-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-fabric-tenant-id': '<x-fabric-tenant-id>',
    'x-fabric-channel-id': '<x-fabric-channel-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    filters: [
      {condition: 'EQ', field: 'shippingMethod.addressType', value: 'APO'},
      {condition: 'IN', field: 'shippingMethod.maximumDays', values: [10, 20]}
    ],
    sort: '-shippingMethod.createdAt'
  })
};

fetch('https://api.fabric.inc/v3/shipping-methods/search', 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.fabric.inc/v3/shipping-methods/search",
  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([
    'filters' => [
        [
                'condition' => 'EQ',
                'field' => 'shippingMethod.addressType',
                'value' => 'APO'
        ],
        [
                'condition' => 'IN',
                'field' => 'shippingMethod.maximumDays',
                'values' => [
                                10,
                                20
                ]
        ]
    ],
    'sort' => '-shippingMethod.createdAt'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-fabric-channel-id: <x-fabric-channel-id>",
    "x-fabric-tenant-id: <x-fabric-tenant-id>"
  ],
]);

$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.fabric.inc/v3/shipping-methods/search"

	payload := strings.NewReader("{\n  \"filters\": [\n    {\n      \"condition\": \"EQ\",\n      \"field\": \"shippingMethod.addressType\",\n      \"value\": \"APO\"\n    },\n    {\n      \"condition\": \"IN\",\n      \"field\": \"shippingMethod.maximumDays\",\n      \"values\": [\n        10,\n        20\n      ]\n    }\n  ],\n  \"sort\": \"-shippingMethod.createdAt\"\n}")

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

	req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
	req.Header.Add("x-fabric-channel-id", "<x-fabric-channel-id>")
	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://api.fabric.inc/v3/shipping-methods/search")
  .header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
  .header("x-fabric-channel-id", "<x-fabric-channel-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": [\n    {\n      \"condition\": \"EQ\",\n      \"field\": \"shippingMethod.addressType\",\n      \"value\": \"APO\"\n    },\n    {\n      \"condition\": \"IN\",\n      \"field\": \"shippingMethod.maximumDays\",\n      \"values\": [\n        10,\n        20\n      ]\n    }\n  ],\n  \"sort\": \"-shippingMethod.createdAt\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/shipping-methods/search")

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

request = Net::HTTP::Post.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["x-fabric-channel-id"] = '<x-fabric-channel-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": [\n    {\n      \"condition\": \"EQ\",\n      \"field\": \"shippingMethod.addressType\",\n      \"value\": \"APO\"\n    },\n    {\n      \"condition\": \"IN\",\n      \"field\": \"shippingMethod.maximumDays\",\n      \"values\": [\n        10,\n        20\n      ]\n    }\n  ],\n  \"sort\": \"-shippingMethod.createdAt\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "code": "SDD",
      "name": "Express Delivery",
      "addressType": "APO",
      "attributes": {
        "carrier": "FedEx",
        "type": "Next Day"
      },
      "carrier": "FedEx",
      "cartValue": {
        "max": 3.1,
        "min": 2.1
      },
      "channelId": "12",
      "configuredBy": "User3",
      "cost": 20.5,
      "createdAt": "2022-08-01T20:03:28.483Z",
      "createdBy": "User1",
      "currency": "USD",
      "cutoffTime": 1330,
      "description": "Express Delivery 2 - 5 days",
      "dimension": {
        "max": {
          "height": 2.4,
          "length": 4.6,
          "uom": "EA",
          "width": 3.5
        },
        "min": {
          "height": 2.4,
          "length": 4.6,
          "uom": "EA",
          "width": 3.5
        }
      },
      "isDeleted": false,
      "maximumDays": 5,
      "minimumDays": 2,
      "region": "CA",
      "shippingMethodId": "5349b4ddd2781d08c09890f4",
      "taxCode": "FR01",
      "updatedAt": "2022-08-01T20:03:28.483Z",
      "updatedBy": "User2",
      "weight": {
        "max": 3.1,
        "min": 2.1
      }
    }
  ],
  "pagination": {
    "count": 1000,
    "limit": 10,
    "offset": 1
  },
  "stats": [
    "<string>"
  ]
}
{
  "errors": [
    {
      "message": "Invalid request",
      "type": "CLIENT_ERROR"
    }
  ],
  "message": "Bad request",
  "type": "CLIENT_ERROR"
}
{
  "message": "Unauthorized request",
  "type": "CLIENT_ERROR"
}
{
  "message": "Internal server error",
  "type": "SERVER_ERROR"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

​
x-fabric-channel-id
string
required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

​
x-fabric-request-id
string

Unique request ID

Query Parameters

​
offset
integer<int32>
default:0

Number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.

Example:

0

​
limit
integer<int32>
default:10

Maximum number of records per page

Required range: 1 <= x <= 100
Example:

10

Body

application/json

Search criteria

​
filters
object[]
required
Maximum array length: 50

Criteria to find shipments by a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used.

​
sort
string
default:-shippingMethod.createdAt

Field or property name to sort the results. + represents ascending and - represents descending order of sorting

Pattern: (^[+-]shippingMethod\.[a-zA-Z.\-_]*)(,([+-]shippingMethod\.[a-zA-Z.\-_]*)){0,}
Example:

"+shippingMethod.createdAt"

Response

Returns list of shipping methods

Search response

​
data
object[]
​
pagination
object

Pagination response

​
stats
string[]

A list of stats.

The stats details.