Create a fulfillment

Method : POST

https://admin.vucustom.com/api/:api_version/fulfillments

Example Request

curl --location 'https://admin.vucustom.com/api/v1/fulfillments' \
--data '{
  "fulfillment": {
    "tracking_number": "12345",
    "carrier_code": "FED",
    "carrier_name": "Fedex",
    "service_code": "NDA",
    "service_name": "Next day air",
		"weight": 1.5,
    "recipient": {
      "city": "Test",
      "country": "US",
      "address_1": "test str 1",
      "state_region": "DE",
      "phone": "123",
      "name": "Test Test",
     "postal_code": "123"
    },
    "order_lines": [
      {
        "id": "391",
       "line_reference": "12345",
        "quantity": 3
      }
    ],
    "dimensions": {
      "length": 3,
      "height": 3.5,
      "width": 3
    }
  }
}'

Request Body Schema (Fulfillment )

Field Name	Type	Required	Description
tracking_number	string	Yes	Shipment tracking number
carrier_code	string	Yes	Carrier identifier code
carrier_name	string	Yes	Carrier name
service_code	string	Yes	Service level code
service_name	string	Yes	Service level name
weight	string	Yes	Package weight
recipient	object	Yes	Delivery recipient details. refer to the schema below for details.
order_lines	array	Yes	This is an array of objects. Each object is order line item. refer to the schema below for more details.
dimensions	object	Yes	Package dimensions object. refer to the schema below for more information.

Recipient Schema

Field Name	Type	Required	Description
city	string	Yes	Recipient city
country_code	string	Yes	Recipient country code
address_1	string	Yes	Primary address
state_region	string	Yes	State/region code
phone	string	Yes	Contact phone
name	string	Yes	Recipient name
postal_code	string	Yes	Postal code

Orderline schema

Field Name	Type	Required	Description
id	String	Yes	Order line ID
line_reference	String	Yes	Line reference
quantity	Integer	Yes	Quantity being fulfilled

Dimensions Schema

Field Name	Type	Required	Description
length	Integer	No	Package length
height	Integer	No	Package height
width	Integer	No	Package width

200

200 Successful response example

{
  "fulfillment": {
    "tracking_number": "12345",
    "carrier_code": "FED",
    "carrier_name": "Fedex",
    "service_code": "NDA",
    "service_name": "Next day air",
    "weight": 1.5,
    "recipient": {
      "city": "Test",
      "country": "US",
      "address_1": "test str 1",
      "state_region": "DE",
      "phone": "123",
      "name": "Test Test",
      "postal_code": "123"
    },
    "order_lines": [
      {
        "id": "391",
        "line_reference": "12345",
        "quantity": 3
      }
    ],
    "dimensions": {
      "length": 3,
      "height": 3.5,
      "width": 3
    }
  }
}

401

401 Unauthorized

The client doesn’t have correct authentication credentials.

{
"errors": "[API] Invalid API key or secret (unrecognized login or wrong password)"
}

422

422 Unprocessable Entity

5xx

5xx Errors

An internal error occurred in VU Admin.