Create a fulfillment order

curl --request POST \
  --url https://api.example.com/v1/fulfillment_orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "ship_to": {
    "name": "<string>",
    "company": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "tax_ids": [
      {
        "value": "<string>",
        "country": "<string>"
      }
    ],
    "instructions": "<string>",
    "access_point": {
      "carrier": "<string>",
      "id": "<string>"
    }
  },
  "lines": [
    {
      "product": "<string>",
      "quantity": 123,
      "lot_policy": "<string>"
    }
  ],
  "channel": {},
  "order": {
    "id": "<string>",
    "reference": "<string>",
    "channel": "<string>",
    "ordered_at": "2023-11-07T05:31:56Z",
    "currency": "<string>",
    "insurance_charge": {
      "amount": 123,
      "currency": "usd"
    },
    "invoice": {
      "number": "<string>",
      "date": "2023-12-25",
      "file": "<string>"
    },
    "buyer": {
      "name": "<string>",
      "company": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "tax_ids": [
        {
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "instructions": "<string>",
      "access_point": {
        "carrier": "<string>",
        "id": "<string>"
      }
    },
    "seller": {
      "name": "<string>",
      "company": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "tax_ids": [
        {
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "instructions": "<string>",
      "access_point": {
        "carrier": "<string>",
        "id": "<string>"
      }
    }
  },
  "facility": "<string>",
  "allocation": {
    "strategy": "<string>",
    "split_allowed": true
  },
  "shipping": {},
  "packing": {},
  "cancel_unfulfillable": true,
  "user_metadata": {}
}
'

import requests

url = "https://api.example.com/v1/fulfillment_orders"

payload = {
    "ship_to": {
        "name": "<string>",
        "company": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "tax_ids": [
            {
                "value": "<string>",
                "country": "<string>"
            }
        ],
        "instructions": "<string>",
        "access_point": {
            "carrier": "<string>",
            "id": "<string>"
        }
    },
    "lines": [
        {
            "product": "<string>",
            "quantity": 123,
            "lot_policy": "<string>"
        }
    ],
    "channel": {},
    "order": {
        "id": "<string>",
        "reference": "<string>",
        "channel": "<string>",
        "ordered_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "insurance_charge": {
            "amount": 123,
            "currency": "usd"
        },
        "invoice": {
            "number": "<string>",
            "date": "2023-12-25",
            "file": "<string>"
        },
        "buyer": {
            "name": "<string>",
            "company": "<string>",
            "email": "jsmith@example.com",
            "phone": "<string>",
            "tax_ids": [
                {
                    "value": "<string>",
                    "country": "<string>"
                }
            ],
            "instructions": "<string>",
            "access_point": {
                "carrier": "<string>",
                "id": "<string>"
            }
        },
        "seller": {
            "name": "<string>",
            "company": "<string>",
            "email": "jsmith@example.com",
            "phone": "<string>",
            "tax_ids": [
                {
                    "value": "<string>",
                    "country": "<string>"
                }
            ],
            "instructions": "<string>",
            "access_point": {
                "carrier": "<string>",
                "id": "<string>"
            }
        }
    },
    "facility": "<string>",
    "allocation": {
        "strategy": "<string>",
        "split_allowed": True
    },
    "shipping": {},
    "packing": {},
    "cancel_unfulfillable": True,
    "user_metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ship_to: {
      name: '<string>',
      company: '<string>',
      email: 'jsmith@example.com',
      phone: '<string>',
      tax_ids: [{value: '<string>', country: '<string>'}],
      instructions: '<string>',
      access_point: {carrier: '<string>', id: '<string>'}
    },
    lines: [{product: '<string>', quantity: 123, lot_policy: '<string>'}],
    channel: {},
    order: {
      id: '<string>',
      reference: '<string>',
      channel: '<string>',
      ordered_at: '2023-11-07T05:31:56Z',
      currency: '<string>',
      insurance_charge: {amount: 123, currency: 'usd'},
      invoice: {number: '<string>', date: '2023-12-25', file: '<string>'},
      buyer: {
        name: '<string>',
        company: '<string>',
        email: 'jsmith@example.com',
        phone: '<string>',
        tax_ids: [{value: '<string>', country: '<string>'}],
        instructions: '<string>',
        access_point: {carrier: '<string>', id: '<string>'}
      },
      seller: {
        name: '<string>',
        company: '<string>',
        email: 'jsmith@example.com',
        phone: '<string>',
        tax_ids: [{value: '<string>', country: '<string>'}],
        instructions: '<string>',
        access_point: {carrier: '<string>', id: '<string>'}
      }
    },
    facility: '<string>',
    allocation: {strategy: '<string>', split_allowed: true},
    shipping: {},
    packing: {},
    cancel_unfulfillable: true,
    user_metadata: {}
  })
};

fetch('https://api.example.com/v1/fulfillment_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://api.example.com/v1/fulfillment_orders",
  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([
    'ship_to' => [
        'name' => '<string>',
        'company' => '<string>',
        'email' => 'jsmith@example.com',
        'phone' => '<string>',
        'tax_ids' => [
                [
                                'value' => '<string>',
                                'country' => '<string>'
                ]
        ],
        'instructions' => '<string>',
        'access_point' => [
                'carrier' => '<string>',
                'id' => '<string>'
        ]
    ],
    'lines' => [
        [
                'product' => '<string>',
                'quantity' => 123,
                'lot_policy' => '<string>'
        ]
    ],
    'channel' => [
        
    ],
    'order' => [
        'id' => '<string>',
        'reference' => '<string>',
        'channel' => '<string>',
        'ordered_at' => '2023-11-07T05:31:56Z',
        'currency' => '<string>',
        'insurance_charge' => [
                'amount' => 123,
                'currency' => 'usd'
        ],
        'invoice' => [
                'number' => '<string>',
                'date' => '2023-12-25',
                'file' => '<string>'
        ],
        'buyer' => [
                'name' => '<string>',
                'company' => '<string>',
                'email' => 'jsmith@example.com',
                'phone' => '<string>',
                'tax_ids' => [
                                [
                                                                'value' => '<string>',
                                                                'country' => '<string>'
                                ]
                ],
                'instructions' => '<string>',
                'access_point' => [
                                'carrier' => '<string>',
                                'id' => '<string>'
                ]
        ],
        'seller' => [
                'name' => '<string>',
                'company' => '<string>',
                'email' => 'jsmith@example.com',
                'phone' => '<string>',
                'tax_ids' => [
                                [
                                                                'value' => '<string>',
                                                                'country' => '<string>'
                                ]
                ],
                'instructions' => '<string>',
                'access_point' => [
                                'carrier' => '<string>',
                                'id' => '<string>'
                ]
        ]
    ],
    'facility' => '<string>',
    'allocation' => [
        'strategy' => '<string>',
        'split_allowed' => true
    ],
    'shipping' => [
        
    ],
    'packing' => [
        
    ],
    'cancel_unfulfillable' => true,
    'user_metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/fulfillment_orders"

	payload := strings.NewReader("{\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"tax_ids\": [\n      {\n        \"value\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ],\n    \"instructions\": \"<string>\",\n    \"access_point\": {\n      \"carrier\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  },\n  \"lines\": [\n    {\n      \"product\": \"<string>\",\n      \"quantity\": 123,\n      \"lot_policy\": \"<string>\"\n    }\n  ],\n  \"channel\": {},\n  \"order\": {\n    \"id\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"ordered_at\": \"2023-11-07T05:31:56Z\",\n    \"currency\": \"<string>\",\n    \"insurance_charge\": {\n      \"amount\": 123,\n      \"currency\": \"usd\"\n    },\n    \"invoice\": {\n      \"number\": \"<string>\",\n      \"date\": \"2023-12-25\",\n      \"file\": \"<string>\"\n    },\n    \"buyer\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    },\n    \"seller\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    }\n  },\n  \"facility\": \"<string>\",\n  \"allocation\": {\n    \"strategy\": \"<string>\",\n    \"split_allowed\": true\n  },\n  \"shipping\": {},\n  \"packing\": {},\n  \"cancel_unfulfillable\": true,\n  \"user_metadata\": {}\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.example.com/v1/fulfillment_orders")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"tax_ids\": [\n      {\n        \"value\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ],\n    \"instructions\": \"<string>\",\n    \"access_point\": {\n      \"carrier\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  },\n  \"lines\": [\n    {\n      \"product\": \"<string>\",\n      \"quantity\": 123,\n      \"lot_policy\": \"<string>\"\n    }\n  ],\n  \"channel\": {},\n  \"order\": {\n    \"id\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"ordered_at\": \"2023-11-07T05:31:56Z\",\n    \"currency\": \"<string>\",\n    \"insurance_charge\": {\n      \"amount\": 123,\n      \"currency\": \"usd\"\n    },\n    \"invoice\": {\n      \"number\": \"<string>\",\n      \"date\": \"2023-12-25\",\n      \"file\": \"<string>\"\n    },\n    \"buyer\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    },\n    \"seller\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    }\n  },\n  \"facility\": \"<string>\",\n  \"allocation\": {\n    \"strategy\": \"<string>\",\n    \"split_allowed\": true\n  },\n  \"shipping\": {},\n  \"packing\": {},\n  \"cancel_unfulfillable\": true,\n  \"user_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/fulfillment_orders")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"tax_ids\": [\n      {\n        \"value\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ],\n    \"instructions\": \"<string>\",\n    \"access_point\": {\n      \"carrier\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  },\n  \"lines\": [\n    {\n      \"product\": \"<string>\",\n      \"quantity\": 123,\n      \"lot_policy\": \"<string>\"\n    }\n  ],\n  \"channel\": {},\n  \"order\": {\n    \"id\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"ordered_at\": \"2023-11-07T05:31:56Z\",\n    \"currency\": \"<string>\",\n    \"insurance_charge\": {\n      \"amount\": 123,\n      \"currency\": \"usd\"\n    },\n    \"invoice\": {\n      \"number\": \"<string>\",\n      \"date\": \"2023-12-25\",\n      \"file\": \"<string>\"\n    },\n    \"buyer\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    },\n    \"seller\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    }\n  },\n  \"facility\": \"<string>\",\n  \"allocation\": {\n    \"strategy\": \"<string>\",\n    \"split_allowed\": true\n  },\n  \"shipping\": {},\n  \"packing\": {},\n  \"cancel_unfulfillable\": true,\n  \"user_metadata\": {}\n}"

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

{
  "id": "fo_1Q2w3E4r",
  "object": "fulfillment_order",
  "livemode": true,
  "created": 123,
  "owner": "<string>",
  "status": "received",
  "ship_to": {
    "name": "<string>",
    "company": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "tax_ids": [
      {
        "type": "eori",
        "value": "<string>",
        "country": "<string>"
      }
    ],
    "address": {
      "line1": "<string>",
      "country": "<string>",
      "street_number": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "residential": true,
      "validation": {
        "status": "verified",
        "suggested": "<unknown>",
        "messages": [
          {
            "level": "info",
            "code": "<string>",
            "message": "<string>",
            "param": "<string>",
            "carrier": "<string>"
          }
        ]
      }
    },
    "instructions": "<string>",
    "access_point": {
      "carrier": "<string>",
      "id": "<string>",
      "type": "locker"
    }
  },
  "lines": [
    {
      "product": "<string>",
      "quantity": 123,
      "allocated": 123,
      "picked": 123,
      "packed": 123,
      "lot_policy": "fefo"
    }
  ],
  "updated": 123,
  "channel": {
    "source": "<string>",
    "order_id": "<string>",
    "upstream_reference": "<string>"
  },
  "order": {
    "id": "<string>",
    "reference": "<string>",
    "channel": "<string>",
    "ordered_at": "2023-11-07T05:31:56Z",
    "currency": "<string>",
    "subtotal": {
      "amount": 123,
      "currency": "usd"
    },
    "shipping_charge": {
      "amount": 123,
      "currency": "usd"
    },
    "insurance_charge": {
      "amount": 123,
      "currency": "usd"
    },
    "discount": {
      "amount": 123,
      "currency": "usd"
    },
    "tax": {
      "amount": 123,
      "currency": "usd"
    },
    "total": {
      "amount": 123,
      "currency": "usd"
    },
    "invoice": {
      "number": "<string>",
      "date": "2023-12-25",
      "type": "commercial",
      "terms_of_payment": "prepaid",
      "file": "<string>"
    },
    "buyer": {
      "name": "<string>",
      "company": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "tax_ids": [
        {
          "type": "eori",
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "address": {
        "line1": "<string>",
        "country": "<string>",
        "street_number": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "residential": true,
        "validation": {
          "status": "verified",
          "suggested": "<unknown>",
          "messages": [
            {
              "level": "info",
              "code": "<string>",
              "message": "<string>",
              "param": "<string>",
              "carrier": "<string>"
            }
          ]
        }
      },
      "instructions": "<string>",
      "access_point": {
        "carrier": "<string>",
        "id": "<string>",
        "type": "locker"
      }
    },
    "seller": {
      "name": "<string>",
      "company": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "tax_ids": [
        {
          "type": "eori",
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "address": {
        "line1": "<string>",
        "country": "<string>",
        "street_number": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "residential": true,
        "validation": {
          "status": "verified",
          "suggested": "<unknown>",
          "messages": [
            {
              "level": "info",
              "code": "<string>",
              "message": "<string>",
              "param": "<string>",
              "carrier": "<string>"
            }
          ]
        }
      },
      "instructions": "<string>",
      "access_point": {
        "carrier": "<string>",
        "id": "<string>",
        "type": "locker"
      }
    }
  },
  "facility": "<string>",
  "allocation": {
    "strategy": "<string>",
    "split_allowed": true,
    "decided_at": 123
  },
  "shipping": {
    "carrier_configs": {
      "*": {
        "signature": "adult",
        "insurance": {
          "amount": 25000,
          "currency": "usd"
        }
      },
      "fedex": {
        "service": "fedex_international_priority",
        "saturday_delivery": true,
        "priority_alert": true
      },
      "ups": {}
    },
    "rate_shop": {},
    "promise": {
      "deliver_by": "2023-12-25"
    }
  },
  "packing": {
    "packaging": "<string>",
    "inserts": [
      "<string>"
    ],
    "gift_message": "<string>"
  },
  "tasks": [
    {
      "type": "<string>",
      "location": "<string>",
      "product": "<string>",
      "quantity": 123,
      "status": "<string>",
      "wave": "<string>"
    }
  ],
  "shipments": [
    "<string>"
  ],
  "documents": [
    {
      "id": "<string>",
      "object": "document",
      "type": "label",
      "format": "pdf",
      "size": "<string>",
      "url": "<string>",
      "url_expires_at": 123,
      "data": "<string>",
      "handling_unit": "<string>",
      "bundle": [
        "<string>"
      ],
      "template": "<string>",
      "template_version": 123,
      "related": {
        "type": "<string>",
        "id": "<string>"
      },
      "file": "<string>",
      "sha256": "<string>"
    }
  ],
  "user_metadata": {},
  "carrier_metadata": {},
  "system_metadata": {
    "source": "api",
    "created_by": {
      "type": "api_key",
      "id": "<string>"
    },
    "request_id": "<string>",
    "idempotency_key": "<string>",
    "batch": "<string>",
    "generated": true,
    "test_scenario": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

POST

fulfillment_orders

Create a fulfillment order

curl --request POST \
  --url https://api.example.com/v1/fulfillment_orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "ship_to": {
    "name": "<string>",
    "company": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "tax_ids": [
      {
        "value": "<string>",
        "country": "<string>"
      }
    ],
    "instructions": "<string>",
    "access_point": {
      "carrier": "<string>",
      "id": "<string>"
    }
  },
  "lines": [
    {
      "product": "<string>",
      "quantity": 123,
      "lot_policy": "<string>"
    }
  ],
  "channel": {},
  "order": {
    "id": "<string>",
    "reference": "<string>",
    "channel": "<string>",
    "ordered_at": "2023-11-07T05:31:56Z",
    "currency": "<string>",
    "insurance_charge": {
      "amount": 123,
      "currency": "usd"
    },
    "invoice": {
      "number": "<string>",
      "date": "2023-12-25",
      "file": "<string>"
    },
    "buyer": {
      "name": "<string>",
      "company": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "tax_ids": [
        {
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "instructions": "<string>",
      "access_point": {
        "carrier": "<string>",
        "id": "<string>"
      }
    },
    "seller": {
      "name": "<string>",
      "company": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "tax_ids": [
        {
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "instructions": "<string>",
      "access_point": {
        "carrier": "<string>",
        "id": "<string>"
      }
    }
  },
  "facility": "<string>",
  "allocation": {
    "strategy": "<string>",
    "split_allowed": true
  },
  "shipping": {},
  "packing": {},
  "cancel_unfulfillable": true,
  "user_metadata": {}
}
'

import requests

url = "https://api.example.com/v1/fulfillment_orders"

payload = {
    "ship_to": {
        "name": "<string>",
        "company": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "tax_ids": [
            {
                "value": "<string>",
                "country": "<string>"
            }
        ],
        "instructions": "<string>",
        "access_point": {
            "carrier": "<string>",
            "id": "<string>"
        }
    },
    "lines": [
        {
            "product": "<string>",
            "quantity": 123,
            "lot_policy": "<string>"
        }
    ],
    "channel": {},
    "order": {
        "id": "<string>",
        "reference": "<string>",
        "channel": "<string>",
        "ordered_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "insurance_charge": {
            "amount": 123,
            "currency": "usd"
        },
        "invoice": {
            "number": "<string>",
            "date": "2023-12-25",
            "file": "<string>"
        },
        "buyer": {
            "name": "<string>",
            "company": "<string>",
            "email": "jsmith@example.com",
            "phone": "<string>",
            "tax_ids": [
                {
                    "value": "<string>",
                    "country": "<string>"
                }
            ],
            "instructions": "<string>",
            "access_point": {
                "carrier": "<string>",
                "id": "<string>"
            }
        },
        "seller": {
            "name": "<string>",
            "company": "<string>",
            "email": "jsmith@example.com",
            "phone": "<string>",
            "tax_ids": [
                {
                    "value": "<string>",
                    "country": "<string>"
                }
            ],
            "instructions": "<string>",
            "access_point": {
                "carrier": "<string>",
                "id": "<string>"
            }
        }
    },
    "facility": "<string>",
    "allocation": {
        "strategy": "<string>",
        "split_allowed": True
    },
    "shipping": {},
    "packing": {},
    "cancel_unfulfillable": True,
    "user_metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ship_to: {
      name: '<string>',
      company: '<string>',
      email: 'jsmith@example.com',
      phone: '<string>',
      tax_ids: [{value: '<string>', country: '<string>'}],
      instructions: '<string>',
      access_point: {carrier: '<string>', id: '<string>'}
    },
    lines: [{product: '<string>', quantity: 123, lot_policy: '<string>'}],
    channel: {},
    order: {
      id: '<string>',
      reference: '<string>',
      channel: '<string>',
      ordered_at: '2023-11-07T05:31:56Z',
      currency: '<string>',
      insurance_charge: {amount: 123, currency: 'usd'},
      invoice: {number: '<string>', date: '2023-12-25', file: '<string>'},
      buyer: {
        name: '<string>',
        company: '<string>',
        email: 'jsmith@example.com',
        phone: '<string>',
        tax_ids: [{value: '<string>', country: '<string>'}],
        instructions: '<string>',
        access_point: {carrier: '<string>', id: '<string>'}
      },
      seller: {
        name: '<string>',
        company: '<string>',
        email: 'jsmith@example.com',
        phone: '<string>',
        tax_ids: [{value: '<string>', country: '<string>'}],
        instructions: '<string>',
        access_point: {carrier: '<string>', id: '<string>'}
      }
    },
    facility: '<string>',
    allocation: {strategy: '<string>', split_allowed: true},
    shipping: {},
    packing: {},
    cancel_unfulfillable: true,
    user_metadata: {}
  })
};

fetch('https://api.example.com/v1/fulfillment_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://api.example.com/v1/fulfillment_orders",
  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([
    'ship_to' => [
        'name' => '<string>',
        'company' => '<string>',
        'email' => 'jsmith@example.com',
        'phone' => '<string>',
        'tax_ids' => [
                [
                                'value' => '<string>',
                                'country' => '<string>'
                ]
        ],
        'instructions' => '<string>',
        'access_point' => [
                'carrier' => '<string>',
                'id' => '<string>'
        ]
    ],
    'lines' => [
        [
                'product' => '<string>',
                'quantity' => 123,
                'lot_policy' => '<string>'
        ]
    ],
    'channel' => [
        
    ],
    'order' => [
        'id' => '<string>',
        'reference' => '<string>',
        'channel' => '<string>',
        'ordered_at' => '2023-11-07T05:31:56Z',
        'currency' => '<string>',
        'insurance_charge' => [
                'amount' => 123,
                'currency' => 'usd'
        ],
        'invoice' => [
                'number' => '<string>',
                'date' => '2023-12-25',
                'file' => '<string>'
        ],
        'buyer' => [
                'name' => '<string>',
                'company' => '<string>',
                'email' => 'jsmith@example.com',
                'phone' => '<string>',
                'tax_ids' => [
                                [
                                                                'value' => '<string>',
                                                                'country' => '<string>'
                                ]
                ],
                'instructions' => '<string>',
                'access_point' => [
                                'carrier' => '<string>',
                                'id' => '<string>'
                ]
        ],
        'seller' => [
                'name' => '<string>',
                'company' => '<string>',
                'email' => 'jsmith@example.com',
                'phone' => '<string>',
                'tax_ids' => [
                                [
                                                                'value' => '<string>',
                                                                'country' => '<string>'
                                ]
                ],
                'instructions' => '<string>',
                'access_point' => [
                                'carrier' => '<string>',
                                'id' => '<string>'
                ]
        ]
    ],
    'facility' => '<string>',
    'allocation' => [
        'strategy' => '<string>',
        'split_allowed' => true
    ],
    'shipping' => [
        
    ],
    'packing' => [
        
    ],
    'cancel_unfulfillable' => true,
    'user_metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/fulfillment_orders"

	payload := strings.NewReader("{\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"tax_ids\": [\n      {\n        \"value\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ],\n    \"instructions\": \"<string>\",\n    \"access_point\": {\n      \"carrier\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  },\n  \"lines\": [\n    {\n      \"product\": \"<string>\",\n      \"quantity\": 123,\n      \"lot_policy\": \"<string>\"\n    }\n  ],\n  \"channel\": {},\n  \"order\": {\n    \"id\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"ordered_at\": \"2023-11-07T05:31:56Z\",\n    \"currency\": \"<string>\",\n    \"insurance_charge\": {\n      \"amount\": 123,\n      \"currency\": \"usd\"\n    },\n    \"invoice\": {\n      \"number\": \"<string>\",\n      \"date\": \"2023-12-25\",\n      \"file\": \"<string>\"\n    },\n    \"buyer\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    },\n    \"seller\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    }\n  },\n  \"facility\": \"<string>\",\n  \"allocation\": {\n    \"strategy\": \"<string>\",\n    \"split_allowed\": true\n  },\n  \"shipping\": {},\n  \"packing\": {},\n  \"cancel_unfulfillable\": true,\n  \"user_metadata\": {}\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.example.com/v1/fulfillment_orders")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"tax_ids\": [\n      {\n        \"value\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ],\n    \"instructions\": \"<string>\",\n    \"access_point\": {\n      \"carrier\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  },\n  \"lines\": [\n    {\n      \"product\": \"<string>\",\n      \"quantity\": 123,\n      \"lot_policy\": \"<string>\"\n    }\n  ],\n  \"channel\": {},\n  \"order\": {\n    \"id\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"ordered_at\": \"2023-11-07T05:31:56Z\",\n    \"currency\": \"<string>\",\n    \"insurance_charge\": {\n      \"amount\": 123,\n      \"currency\": \"usd\"\n    },\n    \"invoice\": {\n      \"number\": \"<string>\",\n      \"date\": \"2023-12-25\",\n      \"file\": \"<string>\"\n    },\n    \"buyer\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    },\n    \"seller\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    }\n  },\n  \"facility\": \"<string>\",\n  \"allocation\": {\n    \"strategy\": \"<string>\",\n    \"split_allowed\": true\n  },\n  \"shipping\": {},\n  \"packing\": {},\n  \"cancel_unfulfillable\": true,\n  \"user_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/fulfillment_orders")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"tax_ids\": [\n      {\n        \"value\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ],\n    \"instructions\": \"<string>\",\n    \"access_point\": {\n      \"carrier\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  },\n  \"lines\": [\n    {\n      \"product\": \"<string>\",\n      \"quantity\": 123,\n      \"lot_policy\": \"<string>\"\n    }\n  ],\n  \"channel\": {},\n  \"order\": {\n    \"id\": \"<string>\",\n    \"reference\": \"<string>\",\n    \"channel\": \"<string>\",\n    \"ordered_at\": \"2023-11-07T05:31:56Z\",\n    \"currency\": \"<string>\",\n    \"insurance_charge\": {\n      \"amount\": 123,\n      \"currency\": \"usd\"\n    },\n    \"invoice\": {\n      \"number\": \"<string>\",\n      \"date\": \"2023-12-25\",\n      \"file\": \"<string>\"\n    },\n    \"buyer\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    },\n    \"seller\": {\n      \"name\": \"<string>\",\n      \"company\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\",\n      \"tax_ids\": [\n        {\n          \"value\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      ],\n      \"instructions\": \"<string>\",\n      \"access_point\": {\n        \"carrier\": \"<string>\",\n        \"id\": \"<string>\"\n      }\n    }\n  },\n  \"facility\": \"<string>\",\n  \"allocation\": {\n    \"strategy\": \"<string>\",\n    \"split_allowed\": true\n  },\n  \"shipping\": {},\n  \"packing\": {},\n  \"cancel_unfulfillable\": true,\n  \"user_metadata\": {}\n}"

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

{
  "id": "fo_1Q2w3E4r",
  "object": "fulfillment_order",
  "livemode": true,
  "created": 123,
  "owner": "<string>",
  "status": "received",
  "ship_to": {
    "name": "<string>",
    "company": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "tax_ids": [
      {
        "type": "eori",
        "value": "<string>",
        "country": "<string>"
      }
    ],
    "address": {
      "line1": "<string>",
      "country": "<string>",
      "street_number": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "residential": true,
      "validation": {
        "status": "verified",
        "suggested": "<unknown>",
        "messages": [
          {
            "level": "info",
            "code": "<string>",
            "message": "<string>",
            "param": "<string>",
            "carrier": "<string>"
          }
        ]
      }
    },
    "instructions": "<string>",
    "access_point": {
      "carrier": "<string>",
      "id": "<string>",
      "type": "locker"
    }
  },
  "lines": [
    {
      "product": "<string>",
      "quantity": 123,
      "allocated": 123,
      "picked": 123,
      "packed": 123,
      "lot_policy": "fefo"
    }
  ],
  "updated": 123,
  "channel": {
    "source": "<string>",
    "order_id": "<string>",
    "upstream_reference": "<string>"
  },
  "order": {
    "id": "<string>",
    "reference": "<string>",
    "channel": "<string>",
    "ordered_at": "2023-11-07T05:31:56Z",
    "currency": "<string>",
    "subtotal": {
      "amount": 123,
      "currency": "usd"
    },
    "shipping_charge": {
      "amount": 123,
      "currency": "usd"
    },
    "insurance_charge": {
      "amount": 123,
      "currency": "usd"
    },
    "discount": {
      "amount": 123,
      "currency": "usd"
    },
    "tax": {
      "amount": 123,
      "currency": "usd"
    },
    "total": {
      "amount": 123,
      "currency": "usd"
    },
    "invoice": {
      "number": "<string>",
      "date": "2023-12-25",
      "type": "commercial",
      "terms_of_payment": "prepaid",
      "file": "<string>"
    },
    "buyer": {
      "name": "<string>",
      "company": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "tax_ids": [
        {
          "type": "eori",
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "address": {
        "line1": "<string>",
        "country": "<string>",
        "street_number": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "residential": true,
        "validation": {
          "status": "verified",
          "suggested": "<unknown>",
          "messages": [
            {
              "level": "info",
              "code": "<string>",
              "message": "<string>",
              "param": "<string>",
              "carrier": "<string>"
            }
          ]
        }
      },
      "instructions": "<string>",
      "access_point": {
        "carrier": "<string>",
        "id": "<string>",
        "type": "locker"
      }
    },
    "seller": {
      "name": "<string>",
      "company": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "tax_ids": [
        {
          "type": "eori",
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "address": {
        "line1": "<string>",
        "country": "<string>",
        "street_number": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "residential": true,
        "validation": {
          "status": "verified",
          "suggested": "<unknown>",
          "messages": [
            {
              "level": "info",
              "code": "<string>",
              "message": "<string>",
              "param": "<string>",
              "carrier": "<string>"
            }
          ]
        }
      },
      "instructions": "<string>",
      "access_point": {
        "carrier": "<string>",
        "id": "<string>",
        "type": "locker"
      }
    }
  },
  "facility": "<string>",
  "allocation": {
    "strategy": "<string>",
    "split_allowed": true,
    "decided_at": 123
  },
  "shipping": {
    "carrier_configs": {
      "*": {
        "signature": "adult",
        "insurance": {
          "amount": 25000,
          "currency": "usd"
        }
      },
      "fedex": {
        "service": "fedex_international_priority",
        "saturday_delivery": true,
        "priority_alert": true
      },
      "ups": {}
    },
    "rate_shop": {},
    "promise": {
      "deliver_by": "2023-12-25"
    }
  },
  "packing": {
    "packaging": "<string>",
    "inserts": [
      "<string>"
    ],
    "gift_message": "<string>"
  },
  "tasks": [
    {
      "type": "<string>",
      "location": "<string>",
      "product": "<string>",
      "quantity": 123,
      "status": "<string>",
      "wave": "<string>"
    }
  ],
  "shipments": [
    "<string>"
  ],
  "documents": [
    {
      "id": "<string>",
      "object": "document",
      "type": "label",
      "format": "pdf",
      "size": "<string>",
      "url": "<string>",
      "url_expires_at": 123,
      "data": "<string>",
      "handling_unit": "<string>",
      "bundle": [
        "<string>"
      ],
      "template": "<string>",
      "template_version": 123,
      "related": {
        "type": "<string>",
        "id": "<string>"
      },
      "file": "<string>",
      "sha256": "<string>"
    }
  ],
  "user_metadata": {},
  "carrier_metadata": {},
  "system_metadata": {
    "source": "api",
    "created_by": {
      "type": "api_key",
      "id": "<string>"
    },
    "request_id": "<string>",
    "idempotency_key": "<string>",
    "batch": "<string>",
    "generated": true,
    "test_scenario": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "carrier": {
      "id": "<string>",
      "connection": "<string>",
      "code": "<string>",
      "message": "<string>"
    },
    "shipment": "<string>",
    "details": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version

string

Shipping-Account

string

Act on behalf of a connected account (acct_...)

Idempotency-Key

string

required

Maximum string length: 255

Body

application/json

ship_to

object

required

A party to a shipment. Either name or company is required. address is required on ship_from, ship_to, return_to, bill_to.

Show child attributes

lines

object[]

required

Show child attributes

channel

object

Show child attributes

order

object

Show child attributes

facility

string

allocation

object

Show child attributes

shipping

object

packing

object

cancel_unfulfillable

boolean

user_metadata

object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

Show child attributes

Response

string

required

Prefixed fo_

Example:

"fo_1Q2w3E4r"

object

enum<string>

required

Available options:

fulfillment_order

livemode

boolean

required

created

integer<unix-time>

required

Unix timestamp (seconds)

owner

string

required

status

enum<string>

required

Available options:

received,

allocated,

backordered,

picking,

packed,

shipped,

partially_shipped,

cancelled

ship_to

object

required

A party to a shipment. Either name or company is required. address is required on ship_from, ship_to, return_to, bill_to.

Show child attributes

lines

object[]

required

Show child attributes

updated

integer<unix-time>

Unix timestamp (seconds)

channel

object

Show child attributes

order

object | null

Show child attributes

facility

string | null

allocation

object

Show child attributes

shipping

object

Show child attributes

packing

object

Show child attributes

tasks

object[]

Show child attributes

shipments

string[]

documents

object[]

Show child attributes

user_metadata

object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

Show child attributes

carrier_metadata

object

read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata

object

read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.

Show child attributes

Overview

Required modules

Optional modules

Create a fulfillment order

Authorizations

Headers

Body

Response