Create fulfillment
curl --request POST \
--url https://api.fabric.inc/v3/carts/{cartId}/fulfillments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
--data '
{
"type": "SHIP_TO",
"price": {
"amount": 12.99
},
"refId": "398427903843",
"attributes": {
"source": "store"
},
"originAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"destinationAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"locationId": "CA",
"pickupPerson": {
"secondary": [
{
"name": {
"first": "John",
"middle": "S",
"last": "Doe"
},
"email": "john@test.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
}
]
}
}
'import requests
url = "https://api.fabric.inc/v3/carts/{cartId}/fulfillments"
payload = {
"type": "SHIP_TO",
"price": { "amount": 12.99 },
"refId": "398427903843",
"attributes": { "source": "store" },
"originAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"destinationAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"locationId": "CA",
"pickupPerson": { "secondary": [
{
"name": {
"first": "John",
"middle": "S",
"last": "Doe"
},
"email": "john@test.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
}
] }
}
headers = {
"x-fabric-tenant-id": "<x-fabric-tenant-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>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'SHIP_TO',
price: {amount: 12.99},
refId: '398427903843',
attributes: {source: 'store'},
originAddress: 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
destinationAddress: 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
locationId: 'CA',
pickupPerson: {
secondary: [
{
name: {first: 'John', middle: 'S', last: 'Doe'},
email: 'john@test.com',
phone: {number: '123-456-7890', type: 'MOBILE'}
}
]
}
})
};
fetch('https://api.fabric.inc/v3/carts/{cartId}/fulfillments', 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/carts/{cartId}/fulfillments",
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([
'type' => 'SHIP_TO',
'price' => [
'amount' => 12.99
],
'refId' => '398427903843',
'attributes' => [
'source' => 'store'
],
'originAddress' => 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
'destinationAddress' => 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
'locationId' => 'CA',
'pickupPerson' => [
'secondary' => [
[
'name' => [
'first' => 'John',
'middle' => 'S',
'last' => 'Doe'
],
'email' => 'john@test.com',
'phone' => [
'number' => '123-456-7890',
'type' => 'MOBILE'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"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/carts/{cartId}/fulfillments"
payload := strings.NewReader("{\n \"type\": \"SHIP_TO\",\n \"price\": {\n \"amount\": 12.99\n },\n \"refId\": \"398427903843\",\n \"attributes\": {\n \"source\": \"store\"\n },\n \"originAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"destinationAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"locationId\": \"CA\",\n \"pickupPerson\": {\n \"secondary\": [\n {\n \"name\": {\n \"first\": \"John\",\n \"middle\": \"S\",\n \"last\": \"Doe\"\n },\n \"email\": \"john@test.com\",\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"MOBILE\"\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-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/carts/{cartId}/fulfillments")
.header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"SHIP_TO\",\n \"price\": {\n \"amount\": 12.99\n },\n \"refId\": \"398427903843\",\n \"attributes\": {\n \"source\": \"store\"\n },\n \"originAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"destinationAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"locationId\": \"CA\",\n \"pickupPerson\": {\n \"secondary\": [\n {\n \"name\": {\n \"first\": \"John\",\n \"middle\": \"S\",\n \"last\": \"Doe\"\n },\n \"email\": \"john@test.com\",\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"MOBILE\"\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fabric.inc/v3/carts/{cartId}/fulfillments")
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["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"SHIP_TO\",\n \"price\": {\n \"amount\": 12.99\n },\n \"refId\": \"398427903843\",\n \"attributes\": {\n \"source\": \"store\"\n },\n \"originAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"destinationAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"locationId\": \"CA\",\n \"pickupPerson\": {\n \"secondary\": [\n {\n \"name\": {\n \"first\": \"John\",\n \"middle\": \"S\",\n \"last\": \"Doe\"\n },\n \"email\": \"john@test.com\",\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"MOBILE\"\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "d6229cdb-0c5b-4885-b1b2-13b94d02488e",
"type": "SHIP_TO",
"refId": "398427903843",
"attributes": {
"source": "store"
},
"originAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"destinationAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"locationId": "CA",
"pickupPerson": {
"primary": {
"name": {
"first": "John",
"middle": "S",
"last": "Doe"
},
"email": "john@test.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
},
"secondary": [
{
"name": {
"first": "John",
"middle": "S",
"last": "Doe"
},
"email": "john@test.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
}
]
},
"price": {
"amount": 12.99
},
"promotions": {
"total": 15,
"collection": [
{
"id": "bb44db95-6fbd-4eed-a1ed-4d99bc91250f",
"amount": 15
}
]
},
"fees": {
"total": 5,
"collection": [
{
"id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"name": "Eco Fee",
"price": {
"amount": 12.99
},
"taxable": true,
"attributes": {
"source": "eco"
},
"tax": {
"total": 3,
"collection": [
{
"amount": 3,
"attributes": {
"rate": "5.0",
"type": "COUNTY"
}
}
]
},
"updatedAt": "2024-06-13T16:50:00.682Z",
"createdAt": "2024-06-13T16:50:00.682Z",
"taxDetails": {
"destinationAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8",
"originAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8"
}
}
]
},
"adjustments": {
"total": 2,
"collection": [
{
"id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"price": {
"amount": 12.99
},
"reason": "Price adjustment from customer representative.",
"attributes": {
"source": "CSR"
},
"updatedAt": "2024-06-13T16:50:00.682Z",
"createdAt": "2024-06-13T16:50:00.682Z"
}
]
},
"tax": {
"total": 3,
"collection": [
{
"amount": 3,
"attributes": {
"rate": "5.0",
"type": "COUNTY"
}
}
]
}
}{
"type": "BAD_REQUEST",
"message": "x-fabric-tenant-id is required"
}{
"type": "CART_NOT_FOUND",
"message": "Cart not found"
}Fulfillment
Create fulfillment
Creates a fulfillment to the corresponding cart.
The Cart ID from the Create cart endpoint is used in the path parameter.
POST
/
carts
/
{cartId}
/
fulfillments
Create fulfillment
curl --request POST \
--url https://api.fabric.inc/v3/carts/{cartId}/fulfillments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
--data '
{
"type": "SHIP_TO",
"price": {
"amount": 12.99
},
"refId": "398427903843",
"attributes": {
"source": "store"
},
"originAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"destinationAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"locationId": "CA",
"pickupPerson": {
"secondary": [
{
"name": {
"first": "John",
"middle": "S",
"last": "Doe"
},
"email": "john@test.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
}
]
}
}
'import requests
url = "https://api.fabric.inc/v3/carts/{cartId}/fulfillments"
payload = {
"type": "SHIP_TO",
"price": { "amount": 12.99 },
"refId": "398427903843",
"attributes": { "source": "store" },
"originAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"destinationAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"locationId": "CA",
"pickupPerson": { "secondary": [
{
"name": {
"first": "John",
"middle": "S",
"last": "Doe"
},
"email": "john@test.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
}
] }
}
headers = {
"x-fabric-tenant-id": "<x-fabric-tenant-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>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'SHIP_TO',
price: {amount: 12.99},
refId: '398427903843',
attributes: {source: 'store'},
originAddress: 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
destinationAddress: 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
locationId: 'CA',
pickupPerson: {
secondary: [
{
name: {first: 'John', middle: 'S', last: 'Doe'},
email: 'john@test.com',
phone: {number: '123-456-7890', type: 'MOBILE'}
}
]
}
})
};
fetch('https://api.fabric.inc/v3/carts/{cartId}/fulfillments', 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/carts/{cartId}/fulfillments",
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([
'type' => 'SHIP_TO',
'price' => [
'amount' => 12.99
],
'refId' => '398427903843',
'attributes' => [
'source' => 'store'
],
'originAddress' => 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
'destinationAddress' => 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
'locationId' => 'CA',
'pickupPerson' => [
'secondary' => [
[
'name' => [
'first' => 'John',
'middle' => 'S',
'last' => 'Doe'
],
'email' => 'john@test.com',
'phone' => [
'number' => '123-456-7890',
'type' => 'MOBILE'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"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/carts/{cartId}/fulfillments"
payload := strings.NewReader("{\n \"type\": \"SHIP_TO\",\n \"price\": {\n \"amount\": 12.99\n },\n \"refId\": \"398427903843\",\n \"attributes\": {\n \"source\": \"store\"\n },\n \"originAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"destinationAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"locationId\": \"CA\",\n \"pickupPerson\": {\n \"secondary\": [\n {\n \"name\": {\n \"first\": \"John\",\n \"middle\": \"S\",\n \"last\": \"Doe\"\n },\n \"email\": \"john@test.com\",\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"MOBILE\"\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-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/carts/{cartId}/fulfillments")
.header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"SHIP_TO\",\n \"price\": {\n \"amount\": 12.99\n },\n \"refId\": \"398427903843\",\n \"attributes\": {\n \"source\": \"store\"\n },\n \"originAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"destinationAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"locationId\": \"CA\",\n \"pickupPerson\": {\n \"secondary\": [\n {\n \"name\": {\n \"first\": \"John\",\n \"middle\": \"S\",\n \"last\": \"Doe\"\n },\n \"email\": \"john@test.com\",\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"MOBILE\"\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fabric.inc/v3/carts/{cartId}/fulfillments")
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["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"SHIP_TO\",\n \"price\": {\n \"amount\": 12.99\n },\n \"refId\": \"398427903843\",\n \"attributes\": {\n \"source\": \"store\"\n },\n \"originAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"destinationAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n \"locationId\": \"CA\",\n \"pickupPerson\": {\n \"secondary\": [\n {\n \"name\": {\n \"first\": \"John\",\n \"middle\": \"S\",\n \"last\": \"Doe\"\n },\n \"email\": \"john@test.com\",\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"MOBILE\"\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "d6229cdb-0c5b-4885-b1b2-13b94d02488e",
"type": "SHIP_TO",
"refId": "398427903843",
"attributes": {
"source": "store"
},
"originAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"destinationAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"locationId": "CA",
"pickupPerson": {
"primary": {
"name": {
"first": "John",
"middle": "S",
"last": "Doe"
},
"email": "john@test.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
},
"secondary": [
{
"name": {
"first": "John",
"middle": "S",
"last": "Doe"
},
"email": "john@test.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
}
]
},
"price": {
"amount": 12.99
},
"promotions": {
"total": 15,
"collection": [
{
"id": "bb44db95-6fbd-4eed-a1ed-4d99bc91250f",
"amount": 15
}
]
},
"fees": {
"total": 5,
"collection": [
{
"id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"name": "Eco Fee",
"price": {
"amount": 12.99
},
"taxable": true,
"attributes": {
"source": "eco"
},
"tax": {
"total": 3,
"collection": [
{
"amount": 3,
"attributes": {
"rate": "5.0",
"type": "COUNTY"
}
}
]
},
"updatedAt": "2024-06-13T16:50:00.682Z",
"createdAt": "2024-06-13T16:50:00.682Z",
"taxDetails": {
"destinationAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8",
"originAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8"
}
}
]
},
"adjustments": {
"total": 2,
"collection": [
{
"id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
"price": {
"amount": 12.99
},
"reason": "Price adjustment from customer representative.",
"attributes": {
"source": "CSR"
},
"updatedAt": "2024-06-13T16:50:00.682Z",
"createdAt": "2024-06-13T16:50:00.682Z"
}
]
},
"tax": {
"total": 3,
"collection": [
{
"amount": 3,
"attributes": {
"rate": "5.0",
"type": "COUNTY"
}
}
]
}
}{
"type": "BAD_REQUEST",
"message": "x-fabric-tenant-id is required"
}{
"type": "CART_NOT_FOUND",
"message": "Cart not found"
}Authorizations
This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.
Headers
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.
Example:
"617329dfd5288b0011332311"
Unique request ID for tracking.
Example:
"263e731c-45c8-11ed-b878-0242ac120002"
x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.
Example:
"12"
Path Parameters
The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint.
Body
application/json
Fulfillment Request
Determines the type of fulfillment.
Available options:
SHIP_TO, BOPIS, ROPIS Example:
"SHIP_TO"
Price details
Show child attributes
Show child attributes
An alternative identifier for fulfillments, used for additional tracking or referencing.
Example:
"398427903843"
Custom attributes to provide more context to the fulfillment, such as where it was made.
Show child attributes
Show child attributes
Example:
{ "source": "store" }
The identifier of the address where the item is being fulfilled.
Example:
"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"
The identifier of the address where the item is being shipped.
Example:
"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"
Unique identifier of the store.
Example:
"CA"
Pickup person details
Show child attributes
Show child attributes
Response
Created
A fulfillment object containing important fulfillment information.
The unique identifier of a fulfillment that was generated by this endpoint. This Fulfillment ID is used for other endpoints.
Example:
"d6229cdb-0c5b-4885-b1b2-13b94d02488e"
Determines the type of fulfillment.
Available options:
SHIP_TO, BOPIS, ROPIS Example:
"SHIP_TO"
An alternative identifier for fulfillments, used for additional tracking or referencing.
Example:
"398427903843"
Custom attributes to provide more context to the fulfillment, such as where it was made.
Show child attributes
Show child attributes
Example:
{ "source": "store" }
The identifier of the address where the item is being fulfilled.
Example:
"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"
The identifier of the address where the item is being shipped.
Example:
"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"
Unique identifier of the store.
Example:
"CA"
Pickup person details
Show child attributes
Show child attributes
Price details
Show child attributes
Show child attributes
A collection of promotions applied to the fulfillment.
Show child attributes
Show child attributes
A collection of fees associated with the corresponding cart.
Show child attributes
Show child attributes
A collection of adjustments made to the corresponding cart.
Show child attributes
Show child attributes
A collection of taxes.
Show child attributes
Show child attributes
Was this page helpful?