ShipNotify Reference
Tip
New Version Coming Soon
This version of the Custom Store spec is still fully supported but a new version is coming soon. Both versions will be supported for some time.
ShipNotify Field Definitions
| Name | XPath | Max Occurrence | Type | Length | Description |
|---|---|---|---|---|---|
| ShipNotice | ShipNotice | 1 | Container | n/a | Root Node |
| OrderId | ShipNotice/OrderID | 1 | String | 1...50 | Unique identifier for an order. |
| OrderNumber | ShipNotice/OrderNumber | 1 | String | 1...50 | User-visible order identifier. |
| CustomerCode | ShipNotice/CustomerCode | 1 | String | 1...50 | A unique identifier of the customer in your system. This is often a username or email address. |
| CustomerNotes | ShipNotice/CustomerNotes | 1 | String | 0...1000 | Notes left by the customer when placing the order. |
| InternalNotes | ShipNotice/InternalNotes | 1 | String | 0...1000 | Private notes that are only viewed by your company. |
| NotesToCustomer | ShipNotice/NotesToCustomer | 1 | String | 0...1000 | Public notes to be communicated to the customer. |
| NotifyCustomer | ShipNotice/NotifyCustomer | 1 | Bool | If ShipStation send the customer a shipment notification email, this value will be "false". | |
| LabelCreateDate | ShipNotice/LabelCreateDate | 1 | Date/time | The date the shipping label was created. UTC time. Format: MM/dd/yyyy HH:MM. | |
| ShipDate | ShipNotice/ShipDate | 1 | Date | The date the package will be shipped. | |
| Carrier | ShipNotice/Carrier | 1 | String | 0...50 | The shipping carrier used (USPS, UPS, FedEx). |
| Service | ShipNotice/Service | 1 | String | 0...50 | The shipping service used. |
| TrackingNumber | ShipNotice/TrackingNumber | 1 | String | 0...50 | The package's tracking number. |
| ShippingCost | ShipNotice/ShippingCost | 1 | Decimal | 9,2 | The cost to ship the package. |
| Recipient | ShipNotice/Recipient | 1 | Container | n/a | Container node for the recipient's address. |
| Name | ShipNotice/Recipient/Name | 1 | String | 1...100 | Recipient's name. |
| Company | ShipNotice/Recipient/Company | 1 | String | 0...100 | Recipient's company. |
| Address1 | ShipNotice/Recipient/Address1 | 1 | String | 1...200 | Recipient's address line 1. |
| Address2 | ShipNotice/Recipient/Address2 | 1 | String | 1...200 | Recipient's address line 1. |
| City | ShipNotice/Recipient/City | 1 | String | 0...100 | Recipient's city. |
| State | ShipNotice/Recipient/State | 1 | String | US and Canadian addresses require the 2 character state/territory code. | |
| PostalCode | ShipNotice/Recipient/PostalCode | 1 | String | 0...50 | Required for domestic addresses and many international addresses. |
| Country | ShipNotice/Recipient/Country | 1 | String | 2 | 2-character country code. |
| Items | ShipNotice/Items | 1 | Container | Container node for the shipment's items. | |
| Item | ShipNotice/Items/Item | Unlimited | Container | Container node for an individual shipment line item. | |
| LineItemID | ShipNotice/Items/Item/LineItemID | 1 per Item | String | 1...50 | Unique identifier for the line item. |
| SKU | ShipNotice/Items/Item/SKU | 1 per Item | String | 1...100 | Unique identifier for the product that was shipped. |
| Name | ShipNotice/Items/Item/Name | 1 per Item | String | 1...200 | Name of the product. |
| Quantity | ShipNotice/Items/Item/Quantity | 1 per Item | Integer | 1...99999 | Quantity of items shipped. |