Object Models

A full list of the objects returned by the endpoints of the VoyageOne API. All API endpoints return data in JSON format.

bill to address object

Property Data Type Description Example Values
addressLine1 string The first line of the address. "123 Main St."
addressLine2 string The second line of the address. "Apt. #137"
"C/O Addison Phelps"
city string The city of the address. "Seattle"
companyName string The company name of the address. "VoyageOne"
country string The ISO 3166-1 alpha-2 country code of the address. "US"
"DE"
"MX"
daytimePhone string The daytime phone number of the person associated with this address. "919-123-4567"
"1-919-123-4568"
emailAddress string The email of the person associated with this address. "jsmith@example.com"
eveningPhone string The evening phone number of the person associated with this address. "919-123-4567"
"1-919-123-4568"
firstName string The first name of the person associated with this address. "John"
lastName string The last name of the person associated with this address. "Smith"
postalCode string The postal code of the address. "27560"
"85204-12345"
stateOrProvince string The ISO 3166-2 state/province code of the address. "NY"
"AK"
"DC"

error object

Property Data Type Description Example Values
code string A high-level description of the error. "E2010002"
message string A more detailed description of the error. "This SKU doesn't exist in the catalog."

order object

Property Data Type Description Example Values
billInfo bill to address object The billing address associated with the order.
deliveryType string The name or code of the carrier. "SYB"
"LZD" - Lazada Order
"KL" - Kaola Order
"UPU"-CC Order
items array of order item objects An array of items contained in the order.
orderAmount number The total amount paid for the order expressed as a decimal, including taxes and shipping. 110
120.5
130.75
orderDiscount number The discount of the order expressed as a decimal. 0
11
12.5
13.75
orderID string The unique identifier that represents this order. "10018734"
"1181000069298115"
orderStatus string The current status of the order on the site. "Open"
"Acknowledged"
"Shipped"
"Canceled"
"CancelRequest"
"Terminated"
"Complete"
orderTax number The total amount paid in taxes for the items of the order. Cannot have more than 2 decimal places 0
4.75
orderTime number The time the order was placed on the marketplace. Timestamps are expressed using the UTC format in milliseconds. To convert to UTC format in seconds, divide the timestamp by 1,000. 1525832708000
orderType string The order type of the order on the site. "normal"
shippingFee number The total amount paid for the order's shipping. Cannot have more than 2 decimal places. 0
11
12.5
13.75
shipLabelType string The file format of the label. "pdf"
"data"
shipLabelValue string The URL of the PDF file or data of the label.

Note: There are two kinds of accepted data that can be provided — Cainiao Cloud print data and Lazada label data. For Cainiao Cloud print data, the Cainiao Print Tool must be installed on your local PC from which you can print labels by transferring the print data to the print tool. For Lazada label data, the label data needs to be base64 decoded and interpreted according to the value of the Media/Mime Type passed in the Content-Type header.

PDF sample:
"https://cdn.alibaba.com/pdf/printlabel001.pdf"
Cloud print data sample:
{"encryptedData":"AES:a3eBibz4eb7M+F9aUeYzlxdPJEXJsSbt9y+i7n/TGcaohtGyBT8546N0hBnaMulpSMJDvjOXQsXDBUMxEYsDvdlvoMXIY/uPkcDuTo8MMtam3NhToH+iWtVr8SkOWEdCJleo1IazuJyrCyPPKSKEreOTVvIej/Mm51amZcvVs3wT4uPTYuK2FntIHRuosSXHJl9IYk5OiRd7ukulV27VcTeE9qhkcPaWS6Av29qKbNhlX/if8TsleLiV/B0kcv08TyAEQkXuxllgrcl1CS8Xd03KPw/1QcyqAJczhaKh8BKv6Oyt3ejvQ5PBZBN8bTdNqPLc4V02w+7mOuTiT5/4t2pMALjmjQHkMvBDxnyfdVUODUDenPhyLogJKWwxYRijEf8IiokW5jGAgYNd8GZ8jujVE6wUE0ACU1FOSeZTlCgZ/lOSc8F+woNep0R+iR5Y693OIRHHj/ieYYhcWRQx9x6ZApXHHxRAEuhMSU4zZZQ5+GUX+mC4oUq6E6KbvEDubBTCEE+6X1h2r7nHP3axRkMMv6UoJ7rY+hmiXW7M5clD9kUdzAjOhHen3wJfK1PGfEMe1o1J3MxgbzZTktlG7w==","signature":"MD:cl23eRG0WfxhAnRI23jSXA==","templateURL":"http://cloudprint.cainiao.com/template/standard/178031"}
Lazada data sample:
"PHRhYmxlIGNlbGxwYWRkaW5nPSIwIiBjZWxsc3BhA2luZz0iMCIgc3R5bGU9IndpZHRoOiA1MDBweDsgaGVpZ2h0OiA1MDBweDsgYm9yZGVyOiAycHggIzAwMCBzb2xpZDsiPgoJPHRib2R5PgoJCTx0cj4KCQkJPHRkIGNvbHNwYW49IjIiIHN0eWxlPSJ3aWR0aDogMTAwcHg7Ij48aW1nIHNyYz0iaHR0cDovL3ZpZ25ldHRlMy53aWtpYS5ub2Nvb2tpZS5uZXQvbG9nb3BlZGlhL2ltYWdlcy9mL2ZiL0xhemFkYV9sb2dvX25ldy5wbmcvcmV2aXNpb24vbGF0ZXN0L3NjYWxlLXRvLXdpZHRoLWRvd24vNjQwP2NiPTIwMTUwMTMxMjAzODI1IiB3aWR0aD0iMTAwcHg7IiAvPjwvdGQ+CgkJPC90cj4KCQk8dHI+CgkJCTx0ZCBjb2xzcGFuPSIyIiBzdHlsZT0idGV4dC1hbGlnbjogY2VudGVyOyBib3JkZXItdG9wOiAycHggIzAwMCBzb2xpZDsiPgoJCQk8cD48c3Ryb25nPkxhemFkYSBGaXJzdG1pbGUgVHJhY2tpbmcgTnVtYmVyPC9zdHJvbmc+Jm5ic3A7PC9wPgoKCQkJPHA+PGltZyBzcmM9J2RhdGE6aW1hZ2UvcG5nO2Jhc2U2NCxpVkJPUncwS0dnb0FBQUFOU1VoRVVnQUFBWHNBQUFCa0FRQUFBQUJQc3ExY0FBQUFDWEJJV1hNQUFDbUdBQUFwaGdFaTdOK01BQUFBRW5SRldIUlRiMlowZDJGeVpRQkNZWEpqYjJSbE5Fcnlqbll1QUFBQXhVbEVRVlI0MnUzU01RckNNQlFHNElLRFM4RWJkSFFPWk9sUTFBTjRCZS9nNUZLOGdvTEhhWkZHQ25ZcGRIUW9nVUxtMGtDR0lHMk5SZXZta083L1B6NzQ0UDJQNXhqVDBVSkp4bEpGdWlGVXlkeWR1VUZBcEdLUzBXS1l1bXZDU0NycHdwaktBUUFBQUFBQUFBQUFBQUFBQUFBQUdNQ2tBSHlpMlZ5SXMrZUxXM1phRVdFQlhqSG55KzBsN09NajE5d0M5TmNrT2RTUHNJMU1hUVdlUDNEMy9MM05TdTBJZE5TVXljNEM2S21nR1V2cnFMWUNjdk05YTlWa1htRFRBZC82Qjd3QjhGMGxOVFRjamVZQUFBQUFTVVZPUks1Q1lJST0nIC8+PC9wPgoJCQk8L3RkPgoJCTwvdHI+CgkJPHRyPgoJCQk8dGQgY29sc3Bhbj0iMiIgc3R5bGU9ImJvcmRlci10b3A6ICAycHggIzAwMCBzb2xpZDsiPgoJCQk8cD5UbzogVGlhbmEgWGllICAtIE1hbGF5c2lhPGJyIC8+CgkJCVNlcnZpY2U6IExhemFkYSBGaXJzdG1pbGUgRnVsZmlsbWVudDwvcD4KCgkJCTxwPjxiciAvPgoJCQlTZWxsZXIgTmFtZTogVG1hbGxPdmVyc2Vhc0Z1bGZpbGxtZW50PGJyIC8+CgkJCVNlbGxlciBBZGRyZXNzOiZuYnNwO3Nlb3VsPGJyIC8+CgkJCVNlbGxlciBDb250YWN0OiA5MzQ5NzYxMDwvcD4KCQkJPC90ZD4KCQk8L3RyPgoJCTx0cj4KCQkJPHRkIGNvbHNwYW49IjIiIHN0eWxlPSJib3JkZXItdG9wOiAgMnB4ICMwMDAgc29saWQ7Ij4KCQkJPHA+UHJvZHVjdCBEZWNyaXB0aW9uOjwvcD4KCgkJCTx0YWJsZT4KCQkJCTx0aGVhZD4KCQkJCQk8dHI+CgkJCQkJCTx0aD5JdGVtIG5hbWU8L3RoPgoJCQkJCQk8dGg+SXRlbSBza3Ugc2VsbGVyPC90aD4KCQkJCQk8L3RyPgoJCQkJPC90aGVhZD4KCQkJCTx0Ym9keT4KCQkJCQk8dHI+CgkJCQkJCTx0ZD5EYWlsaXNtIFNtdWRnZSBTdG9wIE1hc2NhcmEgOWc8L3RkPgoJCQkJCQk8dGQ+Qjk5LUhNQ00xLURTU008L3RkPgoJCQkJCTwvdHI+CgkJCQkJCgkJCQk8L3Rib2R5PgoJCQk8L3RhYmxlPgoKCQkJPHA+PGJyIC8+CgkJCUZpcnN0IE1pbGUgV2FyZWhvdXNlOiAmbmJzcDs8L3A+CgoJCQk8cD7qsr3quLDrj4TquYDtj6zsi5zqs6DstIzsnY3slYTrnbzsnKHroZwgMzco7KCE7Zi466asIDcyNinsoJXsiJjsnKDthrUgMuy4tSBDSuuMgO2VnO2GteyatCBHRkMg7IS87YSwIDLsuLU8L3A+CgkJCTwvdGQ+CgkJPC90cj4KCQk8dHI+CgkJCTx0ZCBzdHlsZT0iYm9yZGVyLXJpZ2h0OiAxcHggc29saWQgcmdiKDAsIDAsIDApOyBib3JkZXItdG9wOiAycHggc29saWQgcmdiKDAsIDAsIDApOyB3aWR0aDogNjUlOyBoZWlnaHQ6IDgwcHg7IHRleHQtYWxpZ246IHJpZ2h0OyI+PHNwYW4gc3R5bGU9ImZvbnQtc2l6ZToxNnB4OyI+U29ydCBDb2RlPC9zcGFuPjxzcGFuIHN0eWxlPSJmb250LXNpemU6MThweDsiPiAmbmJzcDs8L3NwYW4+PC90ZD4KCQkJPHRkIHN0eWxlPSJ0ZXh0LWFsaWduOiBjZW50ZXI7IGJvcmRlci10b3A6ICAycHggIzAwMCBzb2xpZDsiPgoJCQk8cD48Zm9udCBzaXplPSI1Ij48c3Ryb25nPkxaRE1ZPC9zdHJvbmc+PC9mb250PjwvcD4KCQkJPC90ZD4KCQk8L3RyPgoJCTx0cj4KCQkJPHRkIGNvbHNwYW49IjIiIHN0eWxlPSJib3JkZXItdG9wOiAgMnB4ICMwMDAgc29saWQ7IHRleHQtYWxpZ246IGNlbnRlcjsiPkxhemFkYSBQYWNrYWdlIE51bWJlcjxiciAvPgoJCQk8YnIgLz4KCQkJT1AwNzkwMjA3MzA1OTc4MzwvdGQ+CgkJPC90cj4KCTwvdGJvZHk+CjwvdGFibGU+Cg=="
shipToInfo ship to address object The shipping address associated with the order.
trackingNo string The tracking number that is preset. "1234567890"

order item object

Property Data Type Description Example Values
qty number The number of units ordered for the item. 0
1
120
1349
size string The size, volume or number of servings per item. "8.5"
"XXS"
"Large"
"50oz"
"30ml"
"30 servings"
sku string The unique identifier of the item. "b37572-8.5"
"lw181k52-940-XS"
"531592"
title string The product title/name. "Nike Roshe One"
"Classic Box Chain"
"Patchouli"
unitDiscount number The discounted amount of the item. 0
11
12.5
13.75
unitPrice number The purchase price of the item. 110
120.5
130.75
unitTax number The tax charged for the item. 0
110
120.5
130.75

order result object

Property Data Type Description Example Values
orderId string The order ID of the order for which an order status update was performed. By the order ID being returned as the result indicates the API request was successful. "10018734"
"1181000069298115"

product item object

Property Data Type Description Example Values
sku string Required. A unique identifier for the item. The SKU must be unique for each item in the product variant. After you have established a SKU for an item, do not change it without first contacting VoyageOne support.

Valid characters include any combination of uppercase letters (A–Z), lowercase letters (a–z), . (period), - (hyphen or dash) and _ (underscore). Values cannot contain spaces or non-English characters.

Value has a maximum character length of 50.

"b37572-8.5"
"lw181k52-940-XS"
"531592"
size string Required. The size of your product.The value varies based on the category and will be either the actual size, volume or expiration.

when the industry of "beauty", "health_care", "personal_care", "maternity_baby", "grocery_amp_gourmet_food", the size is not allowed only number.

  • For shoes, the value should be expressed as 8, 9.5, 10, 42, etc.
  • For apparel, the value should be expressed as XXS, M, Large, etc.
  • For beauty products, the size represents the volume and should expressed as 50oz, 30ml, etc.
  • For the supplement category, the size is the number of servings and should be expressed as 30 servings, 60 servings, etc.

Value has a maximum character length of 100.

"Large"
"8.5"
"XL"
variationValue string The standard of the variation what you want to show in the TKOF's sales . This need be unique under one product. For instance, red, 5.5 US, 2.5 lb, blue etc..

Value has a maximum character length of 20.

"8.5"
"XXS"
"Large"
"50oz"
"30ml"
"30 servings"
barcode string Required. A standard, alphanumeric string that uniquely identifies the item. This could be a GCID (16 alphanumeric characters), UPC or EAN.

Value has a maximum character length of 50.

"191525258424"
mfBarcode string Manufacturer barcode

Value has a maximum character length of 50.

"191525258424"
weight number Required. The weight of the item expressed in decimals. 3
3.5
3.55
weightUnit string Required. The unit of measure used to describe the weight of the item, expressed in grams, kilograms, pounds or ounces. "g"
"kg"
"lb"
"oz"
"none"
currency string The currency should be unified with the currency the vendor selected during registration.

Value is case-insensitive.

"CNY"
"JPY"
"USD"
"EUR"
"GDP"
priceMsrp number Required. Manufacturer's suggested retail price of the item expressed as a positive integer or 2 decimal. 400
400.00
1700
1700.00
priceRetail number Required. The sale price at which the merchant offers the item on marketplaces expressed as a positive integer or 2 decimal. This value must be no greater than the priceMsrp. 410
410.00
1800
1800.00
priceCost number Required. The purchase price at which the merchant purchases from the manufacture or supplier. 409
409.99
1699
1699.99
qty number The quantity of the item you are making available for sale expressed as a positive integer. This is your current inventory commitment. A positive value is required for each item that you wish to sell. A product variant and its items can initially be created as "Out of Stock" by setting the value for each item to 0 or by setting the alive property to false. When you are ready to start selling, update each item’s quantity to any value greater than 0 and set the alive property to true.

Default value is 0.

0
1
120
1349
dimension string The length, width and height of the product specified, represented as L*W*H. The preferred format is L*W*H specified in millimeters. The default unit of measurement is assumed to be millimeters if not specified.

When specifying apostrophe and quotation marks to indicate feet and inches, be sure to escape the characters.

"10*20*30"
"60.96*93.98*104.14"
taxRate number Required. For Japanese and European suppliers, the tax rate is required and the value will influence the calculation of the settlement price. For American, Korean and Hong Kong (China) suppliers, please set the value to 0 or null. 0.10
0.19
0

product item result object

Property Data Type Description Example Values
hasErrors boolean Indicates whether the item was successfully updated. true
false
errors array of error objects An array of detected validation errors. The value will be empty if hasErrors is false.
sku string The unique identifier of the updated item. "b37572-8.5"
"lw181k52-940-XS"
"531592"

product object

Property Data Type Description Example Values
code string Required. A unique identifier of the product used to distinguish one product from another. If a product will be listed standalone because the there is only one variant, the item’s SKU can be used for this value.

Valid characters include any combination of uppercase letters (A–Z), lowercase letters (a–z), . (period), - (hyphen or dash) and _ (underscore). Values cannot contain spaces or non-English characters.

Value has a maximum character length of 25.

"b37572"
"lw181k52-940"
mfCode string Manufacturer Code "b37572"
"lw181k52-940"
model string Used to control how products are grouped together on the product page. For example, a pair of shoes may come in three colors. This would require a product to be created for each color. You would then specify the model to be the same for each product variant you wanted to be related in that group.

Valid characters include any combination of uppercase letters (A–Z), lowercase letters (a–z), . (period), - (hyphen or dash) and _ (underscore). Values cannot contain spaces or non-English characters.

"yeezyboost350v2"
"citymarkettote"
"2279586"
brand string Required. The brand of the product.

Value has a maximum character length of 100.

"Champion"
"Nike"
"Sneakerhead"
category string Required. The category/subcategory used to organize the types of products you sell. This value will be used to automatically map the product to the respective category on a marketplace. If you list your products on Amazon or eBay, VoyageOne recommends you use those categories for this value. If Amazon or eBay categories are not available for your products, VoyageOne also provides several category lists you can choose from to match your products. Optionally, VoyageOne may decide to customize the integration to allow the vendor to use their native categories. "Clothing & Accessories > Women > Dresses"
"Clothing & Accessories > Luggage & Bags > Backpacks"
tkofCategoryId string Required. The category/subcategory used to organize the types of products in TKOF. TKOF CategoryList lists
title string Required. The product title/name.

Value has a maximum character length of 150.

"Nike Roshe One"
"Classic Box Chain"
"Patchouli"
shortTitle string The short product title/name.
clientProductURL string The URL of another marketplace where the product is sold such as Amazon or eBay. This can be used by marketing teams to get more detailed information about the product. "https://www.sneakerhead.com/adidas-yeezy-boost-350-v2-b37572.html"
color string Required. The color of the product. This field is not to be used to submit values for team colors, players or names – please use the appropriate properties for these values.

Value has a maximum character length of 100.

"Red"
"Blue"
"Desert Sand"
"Blue/Yellow"
"Turquoise"
createdTime number This is a timestamp generated by system when the product is first created. Timestamps are expressed using the UTC format in milliseconds. To convert to UTC format in seconds, divide the timestamp by 1,000. 1543873864341
material string Required. Describes the material of product.

Value has a maximum character length of 200.

"Leather"
"Suede"
"Polyester"
"Cotton 100%"
description string A long description of the product.

Value has a maximum character length of 4000.

"Gucci Bamboo by Gucci Perfume. Walk into a room with confidence and grace wearing the delicious Gucci Bamboo."

shortDescription string A short description of the product.

Value has a maximum character length of 1000.

"Gucci Bamboo Eau De Parfum Spray for Women"

origin string Required. A two-letter code from the Product Origins property list indicating the country where the product originates from.

Value is case-insensitive.

"US"
"DE"
"MX"
productImages array of strings Required. A list of product image URLs. Typically, a minimum of three images are required to be listed on a marketplace. Each URL in the array should be enclosed within quotation marks and separated by a comma.

Max 25 images can be accepted for each product.

["http://www.example.com/image-1.jpg", "http://www.example.com/image-1.jpg"]

packageImages array of strings A list of product packaging image URLs. Each URL in the array should be enclosed within quotation marks and separated by a comma.

Max 25 images can be accepted for each product.

["http://www.example.com/image-1.jpg", "http://www.example.com/image-1.jpg"]

productType string Required. The type of product specified from the Product Types property list.

Value is case-insensitive.

"apparel"
"medicines & health care"
"shoes"
sizeChartType string Required.The unit of measure specified from the  Size Chart Types property list that is associated with the product item’s size property.

Value is case-insensitive.

"cm"
"inches"
"uk"
sizeChartImage string The URL where the image of size chart is located. "http://www.example.com/image-1.jpg"
sizeType string Required. The type of size specified from the Size Types property list.

Value is case-insensitive.

"Big Kids"
"Women"
"Unisex"
usage string Additional information describing the item’s condition or other special details if available.

Value has a maximum character length of 1000.

"New"
"New Open Box"
"Refurbished"
industry string The industry for TMG marketplace, please refer to the property list for the value. Please refer to the Industries property list for a list of available industries. "beauty"
"clothing_shoes_jewelry"
"electronics"
"health_care"
"home_kitchen"
"maternity_baby"
"personal_care"
"pet"
"grocery_amp_gourmet_food"
items array of product item objects Required. An array of one or more items/variants of one product variant.
customAttributes array of name/value pairs An array of one or more key/value pairs used to provide additional information about the product such as gender, season, etc. Each key/value pair in the array should enclosed with quotation marks.Typical attributes are: declareName、medicalDevice.

Suppliers can refer to the CustomAttributes List or can define customized attribute keys and values.

[
{"declareName": "Health Care products"},
{"gender": "female"},
{"periodOfValidity": "2 years"}
]
filingAttributes array of name/value pairs Conditional required. Additional attributes to facilitate China custom registration process and required for specific TKOF suppliers.

Please refer to the FilingAttributes List or can define customized attribute keys and values.

[
{"originalProductTitle": "SuperNutrition"},
{"chineseProductTitle": "超级保健品"},
{"mainMaterial": "甘油,乙醇"},
{"auxiliaryMaterial1": "可可脂"},
{"auxiliaryMaterial2": "代可可脂"},
{"materialDescription": "无"},
{"chineseHscodeBC": "1235209"},
{"chineseHscodeCC": "5302798"}
]
optAttributes array of name/value pairs Conditional required. Additional attributes for product content optimization for specific TKOF suppliers.

Please refer to the OptAttributes List or can define customized attribute keys and values.

[
{"chineseOptimizeTitle": "一次性洗臉面巾棉柔巾擦臉潔面純棉柔巾抽取式"},
{"chineseSalesPoint": "绵柔"},
{"optimizeMainImages": "https://img.alicdn.com/imgextra/i4/725677994/O1CN01EIUvOM28vIljslf8e_!!725677994.jpg_430x430q90.jpg"},
{"transparentImage": "https://img.alicdn.com/imgextra/i3/6000000006580/O1CN01QDfw1V1yTgjtwkme7_!!6000000006580-0-at.jpg_430x430q90.jpg"},
{"optimizeDescriptionImages": "https://img.alicdn.com/imgextra/i4/725677994/O1CN01EIUvOM28vIljslf8e_!!725677994.jpg_430x430q90.jpg"},
{"optimizeDescriptionContent": "棉柔舒适,抽取方便"},
{"groupMainCode": "WSK-79858"},
{"ColorType": "淡紫色"}
]

product result object

Property Data Type Description Example Values
code string The unique identifier of the product that was created or updated. "b37572"
"lw181k52-940"
hasErrors boolean Indicates whether the product was successfully updated. true
false
errors array of error objects An array of detected validation errors. The value will be empty if hasErrors is false.
itemResults array of product item result objects An array of the items being updated.

ship to address object

Property Data Type Description Example Values
addressLine1 string The first line of the address the order will be shipped to. "123 Main St."
addressLine2 string The second line of the address the order will be shipped to. "Apt. #137"
"C/O Addison Phelps"
city string The city of the address the order will be shipped to. "Seattle"
companyName string The company name of the address the order will be shipped to. "VoyageOne"
country string The ISO 3166-1 alpha-2 country code of the address the order will be shipped to. "US"
"DE"
"MX"
daytimePhone string The daytime phone number of the person associated with this address. "919-123-4567"
"1-919-123-4568"
emailAddress string The email of the person associated with this address. "jsmith@example.com"
eveningPhone string The evening phone number of the person associated with this address. "919-123-4567"
"1-919-123-4568"
firstName string The first name of the person associated with this address. "John"
lastName string The last name of the person associated with this address. "Smith"
postalCode string The postal code of the address the order will be shipped to. "27560"
"85204-12345"
stateOrProvince string The ISO 3166-2 state/province code of the address the order will be shipped to. "NY"
"AK"
"DC"
warehouse string The abbreviation of the VoyageOne warehouse. "LA"
"NY"

ship from address object

Property Data Type Description Example Values
addressLine1 string Required. The first line of the address the order will be shipped from. "123 Main St."
addressLine2 string The second line of the address the order will be shipped from. "Apt. #137"
"C/O Addison Phelps"
city string Required. The city of the address the order will be shipped from. "Seattle"
companyName string Required. The company name of the address the order will be shipped from. "Sneakerhead"
country string Required. The ISO 3166-1 alpha-2 country code of the address the order will be shipped from. "US"
"DE"
"MX"
daytimePhone string Required. The daytime phone number of the person associated with this address. "919-123-4567"
"1-919-123-4568"
emailAddress string Required. The email of the person associated with this address. "jsmith@example.com"
eveningPhone string Required. The evening phone number of the person associated with this address. "919-123-4567"
"1-919-123-4568"
firstName string Required. The first name of the person associated with this address. "John"
lastName string Required. The last name of the person associated with this address. "Smith"
nameSuffix string Additional information about the person associated with this address. "PhD"
"Sr."
"III"
postalCode string Required. The postal code of the address the order will be shipped from. "27560"
"85204-12345"
stateOrProvince string Required. The ISO 3166-2 state/province code of the address the order will be shipped from. "NY"
"AK"
"DC"

tracking result object

Property Data Type Description Example Values
trackingId string A unique identifier used by VoyageOne to track the shipment. "5c37e255bf2d8c3dc38d2864"