shipment
Shipment resource
order_number
string
The order number associated with this shipment. This must be unique (to your company) in our system.
business_unit
string
Your company code in our system.
status
string
Read Only
The status of the order
custom1
string
Optional
A custom field for your use.
custom2
string
Optional
A second custom field for your use.
co_number
string
Read Only
The Deposco generated customer order number
created_date
date
Read Only
The date the order was created
updated_date
date
Read Only
The date the order was last updated
earliest_ship_date
date
YYYY-MM-DD
cancel_by_ship_date
date
YYYY-MM-DD
packing_note
string
Optional
duty_paid_by
string
Optional
The party responsible for duties on international shipments. Valid values are: DDU or DDP
order_source
string
Optional
The source of the order, this is for your use to help identify the source of the order in your system.
shipping
object
Information about the address to ship to, and the method to use.
+ Show properties
service_code
string
This is the shipping method to use
third_party
object
Optional
To use a third party shipping account, pass the following two properties. Note, the address is mandatory.
+ Show properties
third_party_acct
string
Third party billing account to use
address
address
The address associated with the third party shipping account; this is mandatory if using third party billing
+ Show properties
name
string
The full name of the recipient.
attention
string
The attention line of third party account address.
address1
string
The street address of the third party account address.
address2
string
A optional second field for the street address of the third party account address.
city
string
The city or town of the third party account address.
province_code
string
The alphanumeric abreviation of the region (ex: province, state or prefecture) for the third party account address.
zip
string
The postal code (ex. zip, postcode, Eircode) of the third party account address.
country_code
string
The two letter code for the country of the third party account address.
address
address
The mailing address to where the shipment will be sent.
+ Show properties
name
string
The full name of the recipient.
attention
string
The attention line of shipping address.
company
string
The company of the person associated with the shipping address.
address1
string
The street address of the shipping address.
address2
string
A optional second field for the street address of the shipping address.
city
string
The city or town of the shipping address.
province_code
string
The alphanumeric abreviation of the region (ex: province, state or prefecture) for the shipping address.
zip
string
The postal code (ex. zip, postcode, Eircode) of the shipping address.
country_code
string
The two letter code for the country of the shipping address.
billing_address
address
Optional
The billing address of the shipment
+ Show properties
name
string
The full name of the recipient.
attention
string
The attention line of billing address.
company
string
The company of the person associated with the billing address.
address1
string
The street address of the billing address.
address2
string
A optional second field for the street address of the billing address.
city
string
The city or town of the billing address.
province_code
string
The alphanumeric abreviation of the region (ex: province, state or prefecture) for the billing address.
zip
string
The postal code (ex. zip, postcode, Eircode) of the billing address.
country_code
string
The two letter code for the country of the billing address.
line_items
array
A list of line item objects, containing the information about each item to include in the shipment.
+ Show properties
line_number
string
Your line number for this shipment line item.
item
string
The SKU for the item, this must match the item record in our system.
unit_price
float
Optional
The unit price of the item.
qty
integer
The number of this line item to ship.
shipped_qty
integer
Read Only
The quantity of items shipped.
custom1
string
Optional
A custom field for your use.
custom2
string
Optional
A second custom field for your use.
containers
array
Read Only
A list of shipped packages.
+ Show properties
ship_date
datetime
The actual date of the package shipment.
ship_via
string
The actual method used to ship the package.
weight
float
The actual weight of the package.
tracking_number
string
The tracking number of the package.
tracking_url
string
The tracking url for the package, if available.
items
array
A list of the items contained in this package
+ Show properties
line_number
string
The corresponding line number for the shipment's items.
item
string
The item's SKU.
shipped_qty
integer
The quantity contained in this package.
puchase_order
Purchase Order resource
order_number
string
The order number associated with this purchase order. This must be unique (to your company) in our system.
reference_number
string
A secondary number associated with this purchase order.
business_unit
string
Your company code in our system.
status
string
Read Only
The status of the purchase order.
expected_date
datetime
The expected date of arrival at our warehouse.
vendor
string
Optional
The vendor the product is coming from.
custom1
string
Optional
A custom field for your use.
custom2
string
Optional
A second custom field for your use.
line_items
array
A list of items contained on the Purchase Order
+ Show properties
line_number
string
Your line number for this inbound line item.
item
string
The SKU for the item, this must match the item record in our system.
qty
string
The quantity of this line item.
received_qty
integer
Read Only
The quantity of this line item received.
lot_number
string
Optional
expire_date
datetime
Optional
return
Return resource
number
string
The return number associated with thie return. This must be unique (to your company) in our system.
order_number
string
Optional
This is the associated order number tied to this return.
business_unit
string
Your company code in our system.
status
string
Read Only
The status of the return.
receipt_date
date
Read Only
The date the warehouse received the return.
tracking_number
string
Optional
The tracking number tied to the return shipment.
address
address
Optional
The mailing address this return is coming from.
+ Show properties
name
string
The full name of the recipient.
address1
string
The street address of the shipping address.
address2
string
A optional second field for the street address of the shipping address.
city
string
The city or town of the shipping address.
province_code
string
The alphanumeric abreviation of the region (ex: province, state or prefecture) for the shipping address.
zip
string
The postal code (ex. zip, postcode, Eircode) of the shipping address.
country_code
string
The two letter code for the country of the shipping address.
expected_date
date
Optional
YYYY-MM-DD
custom1
string
Optional
A custom field for your use.
custom2
string
Optional
A second custom field for your use.
line_items
array
A list of line item objects, containing the information about each item to included in the return.
+ Show properties
line_number
string
Your line number for this shipment line item.
item
string
The SKU for the item, this must match the item record in our system.
qty
integer
The number of this line item to ship.
serial_number
string
Optional
The serial number tied to this item
expected_disposition
string
Optional
The expected disposition of the item being returned
©2024 Verde Fulfillment USA