For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve a fulfillment

Method : GET

https://os.vucustom.com/api/v1/fulfillments?id=&tracking_number=

URL Parameters

Field Name
Description

id

System-generated unique identifier for the fulfillment

tracking_number

Carrier-provided tracking number

Example Request
https://os.vucustom.com/api/v1/fulfillments?id=&tracking_number=

200 Successful response example

{
	"fulfillment": {
		"id": 78,
		"tracking_number": "12345",
		"carrier_name": "Fedex",
		"carrier_code": "FED",
		"service_name": "Next day air",
		"service_code": "NDA",
		"weight": "1.5",
		"recipient": {
			"recipient_address_1": "test str 1",
			"recipient_city": "Test",
			"recipient_name": "Test Test",
			"recipient_state_region": "DE",
			"recipient_country": "US",
			"recipient_postal_code": "123",
			"recipient_phone": "123"
		},
		"dimensions": {
			"height": "3.5",
			"width": "3.0",
			"length": "3.0"
		},
		"order_lines": [
			{
				"id": 110,
				"order_line_id": 391,
				"quantity": 1
			}
		]
	}
}

401 Unauthorized

The client doesn’t have correct authentication credentials.

403 Forbidden

The server is refusing to respond. This is typically caused by incorrect access.

404 Not Found

The requested resource was not found but could be available again in the future.

422 Unprocessable Entity

5xx Errors

An internal error occurred in VU Admin.

Last updated