ShipStation Connector Objects
This Data Cloud connector is a beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.
Name | Description |
---|---|
CarrierPackages | Retrieves the list of packages for the specified carrier. |
Carriers | Lists all shipping providers connected to this account. |
CarrierServices | Lists all the available shipping services. |
Customers | Lists customers. |
CustomerTags | Lists customer tags. |
Fulfillments | List all the fulfillments. |
Marketplaces | Lists marketplaces. |
MarketplaceUsernames | List all the marketplace usernames of the customers. |
OrderCustomsItems | Customs Items of the Orders. |
OrderItems | Items of the orders. |
Orders | Lists all orders. |
Products | Lists all the products. |
ProductTags | Lists product tags. |
ShipmentItems | Lists shipment items. |
Shipments | Retrieves the list of shipments. |
StoreRefreshStatus | Lists status of the store refresh. |
Stores | Lists all stores. |
Tags | Lists all the tags defined for this account. |
Users | Lists ShipStation users. |
Warehouses | Lists warehouses. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CarrierCode [KEY] | String | True | Carriers.CarrierCode | No | The carrier's code. |
Code | String | True | No | Unique code for the carrier Carrier Packages. | |
Name | String | True | No | Name of the package. | |
Domestic | Boolean | True | No | True or false for domestic. | |
International | Boolean | True | No | True or false for International. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | Shipment provider Id unique for the carriers. | |
CarrierCode | String | True | No | Unique code of the carrier. | |
AccountNumber | String | True | No | Carrier Account Number. | |
Balance | Double | True | No | Account balance of the carrier. | |
Name | String | True | No | Carrier name. | |
Nickname | String | True | No | Nick Name of the carrier. | |
Primary | Boolean | True | No | True or false for making carrier as primary. | |
RequiresFundedAccount | Boolean | True | No | True or false for requires Funded Account. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CarrierCode [KEY] | String | True | Carriers.CarrierCode | No | Code of the carrier. |
Code | String | True | No | Unique carrier service code. | |
Name | String | True | No | Name of the carrier service. | |
Domestic | Boolean | True | No | True or False for domestic. | |
International | Boolean | True | No | True or False for International. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique customer Id. | |
AddressVerified | String | True | No | Address verified or not for the customer. | |
City | String | True | No | City of the customer. | |
Company | String | True | No | Company of the customer. | |
CountryCode | String | True | No | Country code of the customer. | |
CreateDate | Datetime | True | No | Customer create date. | |
String | True | No | Email id of the customer. | ||
ModifyDate | Datetime | True | No | Date of the Modified details of customer. | |
Name | String | True | No | Name of the customer. | |
Phone | String | True | No | Contact number of the customer. | |
PostalCode | String | True | No | Postal code of the customer. | |
State | String | True | No | Customer residence date. | |
Street1 | String | True | No | Customer street1. | |
Street2 | String | True | No | Customer street2. | |
MarketplaceUsernames | String | True | No | List the information for the MarketPlace usernames. | |
StateCode | String | True | No | Customers that reside in the specified stateCode. | |
MarketplaceId | Long | True | No | Customers that purchased items from the specified marketplaceId. | |
TagId | String | True | CustomerTags.Id | No | Customers that have been tagged with the specified tagId. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CustomerId | Long | True | Customers.Id | No | Id of the customer. |
Id | Integer | True | Tags.Id | No | TagId of the customer. |
Name | String | True | No | Name of the tag. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | Fulfillment Id of the order. | |
CarrierCode | String | True | No | Carrier Code for the order. | |
CreateDate | Datetime | True | No | Fulfillment create Date date. | |
CustomerEmail | String | True | No | Email Id of the customer. | |
DeliveryDate | Date | True | No | Delivery date of the product. | |
FulfillmentFee | Integer | True | No | Fulfillment date of the product. | |
FulfillmentProviderCod | String | True | No | Provider code of the fulfillment. | |
FulfillmentServiceCode | String | True | No | Service code of the fulfillment. | |
MarketplaceNotified | Boolean | True | No | Marketplace is notified or not. | |
NotifyErrorMessage | String | True | No | Error message of the notification. | |
OrderId | Integer | True | Orders.Id | No | Order Id of the product. |
OrderNumber | String | True | No | Order number of the product. | |
ShipDate | Datetime | True | No | Shipping date of the product. | |
ShipToAddressVerified | String | True | No | Shipping address verification status. | |
ShipToCity | String | True | No | Shipping to city. | |
ShipToCompany | String | True | No | Shipping to company. | |
ShipToCountry | String | True | No | Shipping to country. | |
ShipToName | String | True | No | Shipping to name. | |
ShipToPhone | String | True | No | Shipping to phone number. | |
ShipToPostalCode | String | True | No | Shipping to postal code. | |
ShipToResidential | Boolean | True | No | Shipping to residential. | |
ShipToState | String | True | No | Shipping to State. | |
ShipToStreet1 | String | True | No | Shipping to street1. | |
ShipToStreet2 | String | True | No | Shipping to street2. | |
ShipToStreet3 | String | True | No | Shipping to street3. | |
TrackingNumber | String | True | No | Tracking number of the product. | |
UserId | String | True | Users.Id | No | UserId of order. |
VoidDate | Datetime | True | No | Void date of order. | |
Voided | Boolean | True | No | Whether or not the order is voided. | |
VoidRequested | Boolean | True | No | Void. | |
RecipientName | String | False | Yes | Name of the recipient. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | Id of the marketplace. | |
CanConfirmShipments | Boolean | True | No | Can confirm shipments or not. | |
CanRefresh | Boolean | True | No | Whether or not the marketplace can refresh. | |
Name | String | True | No | Name of the Marketplace. | |
SupportsCustomMappings | Boolean | True | No | Marketplace will able to support custom mapping or not. | |
SupportsCustomStatuses | Boolean | True | No | Marketplace will able to support custom statuses or not. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Marketplace customer user Id. | |
CustomerId [KEY] | Long | True | Customers.Id | No | Id of the customer. |
CreateDate | Datetime | True | No | Create date of this record. | |
Marketplace | String | True | No | Name of the marketplace. | |
MarketplaceId | Integer | True | No | Id of the marketplace. | |
ModifyDate | Datetime | True | No | Modify date of this record. | |
Username | String | True | No | Username of the customers. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CustomsItemId [KEY] | Long | True | No | Id of the customs Item. | |
CountryOfOrigin | String | True | No | Origin country of the customs Item. | |
Description | String | True | No | Description of the customs Item. | |
HarmonizedTariffCode | String | True | No | Harmonized tariff code of the customers Item. | |
Quantity | Integer | True | No | Quantity of the customs Item. | |
Value | Double | True | No | Value of the customs Item. | |
OrderId [KEY] | Long | True | No | Id of the Order. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OrderItemId [KEY] | Long | True | No | Id of the Ordered Item. | |
ImageUrl | String | True | No | URL of the ordered Item Image. | |
LineItemKey | String | True | No | Key of the line Item. | |
Name | String | True | No | Name of the ordered Item. | |
Options | String | True | No | List of options associated with this order item. | |
Quantity | Integer | True | No | Quantity of the ordered Item. | |
ShippingAmount | Double | True | No | Shipping amount for the ordered Item. | |
SKU | String | True | No | SKU of the ordered Item. | |
TaxAmount | Double | True | No | Tax amount for the ordered Item. | |
UnitPrice | Double | True | No | Unite price of the Ordered Item. | |
WarehouseLocation | String | True | No | Ordered Item warehouse location. | |
ProductId | Integer | True | Products.Id | No | Product Id of the ordered Id. |
FulfillmentSKU | String | True | No | Fulfillment SKU for the ordered Item. | |
Adjustment | Boolean | True | No | Adjustment is there are not for ordered Item. | |
Upc | String | True | No | UPC of the ordered Item. | |
CreateDate | Datetime | True | No | Create date of this record. | |
ModifyDate | Datetime | True | No | Modify date of this record. | |
WeightUnits | String | True | No | Weight unit of the ordered Item. | |
WeightValue | Double | True | No | Weight value of the ordered Item. | |
WeightWtUnits | Integer | True | No | A numeric value that is equivalent to the units field. | |
OrderId [KEY] | Long | True | Orders.Id | No | Id of the Order. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | The system generated identifier for the order. | |
AdvancedOptionsBillToAccount | String | True | No | Account number of billToParty. | |
AdvancedOptionsBillToCountryCode | String | True | No | Country Code of billToParty. | |
AdvancedOptionsBillToParty | String | True | No | Identifies which party to bill. | |
AdvancedOptionsBillToPostalCode | String | True | No | Postal code of billToParty. | |
AdvancedOptionsContainsAlcohol | Boolean | True | No | Specifies whether the order contains alcohol. | |
AdvancedOptionsCustomField1 | String | True | No | Field that allows for custom data to be associated with an order. | |
AdvancedOptionsCustomField2 | String | True | No | Field that allows for custom data to be associated with an order. | |
AdvancedOptionsCustomField3 | String | True | No | Field that allows for custom data to be associated with an order. | |
AdvancedOptionsMergedIds | String | True | No | Array of orderIds. Each orderId identifies an order that was merged with the associated order. | |
AdvancedOptionsMergedOrSplit | Boolean | True | No | Returns whether or not an order has been merged or split with another order. | |
AdvancedOptionsNonMachinable | Boolean | True | No | Specifies whether the order is non-machinable. | |
AdvancedOptionsParentId | Integer | True | No | If an order has been split, it will return the Parent ID of the order with which it has been split. | |
AdvancedOptionsSaturdayDelivery | Boolean | True | No | Specifies whether the order is to be delivered on a Saturday. | |
AdvancedOptionsSource | String | True | No | Identifies the original source/marketplace of the order. | |
AdvancedOptionsStoreId | Integer | True | No | ID of store that is associated with the order. | |
AdvancedOptionsWarehouseId | Integer | True | No | Specifies the warehouse where to the order is to ship from. | |
AmountPaid | Double | True | No | The total amount paid for the Order. | |
BillToAddressVerified | String | True | No | Billing to address Verified Status. | |
BillToCity | String | True | No | Billing to city. | |
BillToCompany | String | True | No | Billing to company. | |
BillToCountry | String | True | No | Billing to country. | |
BillToName | String | True | No | Billing to Name. | |
BillToPhone | String | True | No | Billing to phone. | |
BillToPostalCode | String | True | No | Billing to postal code. | |
BillToResidential | Boolean | True | No | Billing to residential. | |
BillToState | String | True | No | Billing to state. | |
BillToStreet1 | String | True | No | Billing to street1. | |
BillToStreet2 | String | True | No | Billing to street2. | |
BillToStreet3 | String | True | No | Billing to shipToStreet3. | |
CarrierCode | String | True | No | The code for the carrier that is to be used(or was used) when this order is shipped(was shipped). | |
Confirmation | String | True | No | The type of delivery confirmation that is to be used(or was used) when this order is shipped(was shipped). | |
CreateDate | Datetime | True | No | The timestamp the order was created in ShipStation's database. Read-Only. | |
CustomerEmail | String | True | No | The customer's email address. | |
CustomerId | Integer | True | Customers.Id | No | Unique identifier for the customer. Generated by ShipStation the first time the customer record is created. |
CustomerNotes | String | True | No | Notes left by the customer when placing the order. | |
CustomerUsername | String | True | No | Identifier for the customer in the originating system. This is typically a username or email address. | |
DimensionsHeight | Double | True | No | Height of the order. | |
DimensionsLength | Double | True | No | Length of the order. | |
DimensionsUnits | String | True | No | Units of the order. | |
DimensionsWidth | Double | True | No | Width of the order. | |
ExternallyFulfilled | Boolean | True | No | States whether the order has is current marked as externally fulfilled by the marketplace. | |
ExternallyFulfilledBy | String | True | No | If externally Fulfilled is true then this string will return how the order is being fulfilled by the marketplace. | |
Gift | Boolean | True | No | Specifies whether or not this Order is a gift. | |
GiftMessage | String | True | No | Gift message left by the customer when placing the order. | |
HoldUntilDate | String | True | No | If placed on hold, this date is the expiration date for this order's hold status. | |
InsuranceOptionsInsuredValue | Double | True | No | The shipping insurance information associated with this order.(insured Value). | |
InsuranceOptionsInsureShipment | Boolean | True | No | The shipping insurance information associated with this order.(insured Shipment). | |
InsuranceOptionsProvider | String | True | No | The shipping insurance information associated with this order.(insurance provider). | |
InternalNotes | String | True | No | Private notes that are only visible to the seller. | |
InternationalOptionsContents | String | True | No | Customs information that can be used to generate customs documents for international orders(contents). | |
InternationalOptionsNonDelivery | String | True | No | Customs information that can be used to generate customs documents for international orders(non Delivery). | |
LabelMessages | String | True | No | Label messages of the order. | |
ModifyDate | Datetime | True | No | The timestamp the order was modified in ShipStation. modify Date will equal create Date until a modification is made. | |
OrderDate | Datetime | True | No | The date the order was placed. | |
OrderKey | String | True | No | A user-provided key that should be unique to each order. Can only be initalized during order creation. If the orderkey isn't specified during creation, a unique value will be generated and assigned. | |
OrderNumber | String | True | No | A user-defined order number used to identify an order. | |
OrderStatus | String | True | No | The order's status. Possible values: 'awaiting_payment', 'awaiting_shipment', 'shipped', 'on_hold', 'cancelled' | |
OrderTotal | Double | True | No | The order total. | |
PackageCode | String | True | No | The code for the package type that is to be used(or was used) when this order is shipped(was shipped). | |
PaymentDate | Datetime | True | No | The date the order was paid for. | |
PaymentMethod | String | True | No | Method of payment used by the customer. | |
RequestedShippingService | String | True | No | Identifies the shipping service selected by the customer when placing this order. This value is given to ShipStation by the marketplace/cart. | |
ServiceCode | String | True | No | The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped). | |
ShipByDate | Date | True | No | The date the order is to be shipped before or on. | |
ShipDate | Date | True | No | The date the order was shipped. | |
ShippingAmount | Double | True | No | Shipping amount paid by the customer, if any. | |
ShipToAddressVerified | String | True | No | The recipients shipping address Verified or not. | |
ShipToCity | String | True | No | The recipients shipping city. | |
ShipToCompany | String | True | No | The recipients shipping company. | |
ShipToCountry | String | True | No | The recipients shipping country. | |
ShipToName | String | True | No | The recipients shipping name. | |
ShipToPhone | String | True | No | The recipients shipping phone. | |
ShipToPostalCode | String | True | No | The recipients shipping postal code. | |
ShipToResidential | Boolean | True | No | The recipients shipping residential. | |
ShipToState | String | True | No | The recipients shipping state. | |
ShipToStreet1 | String | True | No | The recipients shipping street1. | |
ShipToStreet2 | String | True | No | The recipients shipping street2. | |
ShipToStreet3 | String | True | No | The recipients shipping street3. | |
TagIds | String | True | No | Array of tagIds associated with this order. | |
TaxAmount | Double | True | No | The total tax amount for the Order. | |
UserId | String | True | No | User assigned to Order/Shipment in the GUID. Read-Only. | |
WeightUnits | String | True | No | Weight of the order units. | |
WeightValue | Double | True | No | Weight of the order value. | |
WeightWtUnits | Integer | True | No | A numeric value that is equivalent to the units field. | |
AdvancedOptionsBillToMyOtherAccount | String | True | No | When using my_other_account as the billToParty value, the shippingProviderId value that is associated with the desired account.Make a List Carriers call to obtain shippingProviderId values. | |
InsuranceOptionsCustomItems | String | True | No | Custom Items. | |
CustomerName | String | False | No | Name of the customer. | |
ItemKeyword | String | False | No | Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | Id of product. | |
Active | Boolean | True | No | Product active or not status. | |
Aliases | String | True | No | Aliases for the product. | |
CreateDate | Datetime | True | No | Create date of this record. | |
CustomsCountryCode | String | True | No | Customs country code of the product. | |
CustomsDescription | String | True | No | Customs description of the product. | |
CustomsTariffNo | String | True | No | Customs traffic number of the product. | |
CustomsValue | Double | True | No | Customs value of the product. | |
DefaultCarrierCode | String | True | No | Default carrier code for the product. | |
DefaultConfirmation | String | True | No | Default confirmation of the product. | |
DefaultCost | Double | True | No | Default cost for the product. | |
DefaultIntlCarrierCode | String | True | No | Default international carrier code of the product. | |
DefaultIntlConfirmation | String | True | No | Default international confirmation code of the product. | |
DefaultIntlPackageCode | String | True | No | Default international package code. | |
DefaultIntlServiceCode | String | True | No | Default international service code. | |
DefaultPackageCode | String | True | No | The default domestic packageType for this product. | |
DefaultServiceCode | String | True | No | The default domestic shipping service for this product. | |
FulfillmentSKU | String | True | No | Stock keeping Unit for the fulfillment of that product by a 3rd party. | |
Height | Double | True | No | The height of the product. Unit of measurement is UI dependent. No conversions will be made from one UOM to another. See our knowledge base here for more details. | |
InternalNotes | String | True | No | Seller's private notes for the product. | |
Length | Double | True | No | The length of the product. Unit of measurement is UI dependent. No conversions will be made from one UOM to another. See our knowledge base here for more details. | |
ModifyDate | Datetime | True | No | The timestamp the product record was modified in ShipStation. Read-Only. | |
Name | String | True | No | Name or description of the product. | |
NoCustoms | Boolean | True | No | If true, this product will not be included on international customs forms. | |
Price | Double | True | No | The unit price of the product. | |
ProductCategoryId | Long | True | No | The system generated identifier for the product category. | |
ProductCategoryName | String | True | No | Name or description for the product category. | |
ProductTypeCustomsCountryCode | String | True | No | Customs Country Code of the Product Type. | |
ProductTypeCustomsDescription | String | True | No | Customs Description of the Product Type. | |
ProductTypeCustomsTariffNo | String | True | No | Customs Tariff No of the Product Type. | |
ProductTypeCustomsValue | Double | True | No | Customs Value of the Product Type. | |
ProductTypeHeight | Double | True | No | Height of the Product Type. | |
ProductTypeDefaultCarrierCode | String | True | No | Default Carrier Code of the Product Type. | |
ProductTypeDefaultIntlCarrierCode | String | True | No | Default International Carrier Code of the Product Type. | |
ProductTypeDefaultIntlPackageCode | String | True | No | Default International Package Code of the Product Type. | |
ProductTypeDefaultIntlServiceCode | String | True | No | Default International Service Code of the Product Type. | |
ProductTypeDefaultPackageCode | String | True | No | Default Package Code of the Product Type. | |
ProductTypeDefaultServiceCode | String | True | No | Default Service Code of the Product Type. | |
ProductTypeId | Long | True | No | Specifies the product type Id. | |
ProductTypeLength | Double | True | No | Length of the Product Type. | |
ProductTypeName | String | True | No | Name of the Product Type. | |
ProductTypeNoCustoms | Boolean | True | No | If true, this product type will not nbe included on international customs forum. | |
ProductTypeWeightOz | Double | True | No | Weight of the Product Type. | |
ProductTypeWidth | Double | True | No | Width of the Product Type. | |
SKU | String | True | No | Stock keeping Unit. A user-defined value for a product to help identify the product. It is suggested that each product should contain a unique SKU. | |
WarehouseLocation | String | True | No | The warehouse location associated with the product record. | |
WeightOz | Double | True | No | The weight of a single item in ounces. | |
Width | Double | True | No | The width of the product. Unit of measurement is UI dependent. No conversions will be made from one UOM to another. See our knowledge base here for more details. | |
Tags | String | True | No | List of Tags of the product. | |
UPC | String | True | No | Return a product that matches the specified UPC code. | |
ShowInactive | Boolean | False | No | Whether the list should include inactive products. | |
TagId | Integer | False | Tags.Id | No | Tag Id of the product |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | Integer | True | Tags.Id | No | The system generated identifier for the product tag. |
Name | String | True | No | Name or description for the product tag. | |
ProductId | Long | True | Products.Id | No | Id of the product. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Id of the ordered Item. | |
ShipmentId | Long | True | No | Id of the Shipment. | |
FulfillmentSKU | String | True | No | The fulfillment SKU associated with this OrderItem if the fulfillment provider requires an identifier other then the SKU. | |
ImageUrl | String | True | No | The public URL to the product image. | |
LineItemKey | String | True | No | An identifier for the OrderItem in the originating system. | |
Name | String | True | No | The name of the product associated with this line item. Cannot be null. | |
OptionsName | String | True | No | Options of the Item. | |
OptionsValue | String | True | No | Options of the Item. | |
ProductId | Integer | True | No | Id of the product. | |
Quantity | Integer | True | No | The quantity of product ordered. | |
SKU | String | True | No | The SKU (stock keeping unit) identifier for the product associated with this line item. | |
UnitPrice | Double | True | No | The sell price of a single item specified by the order source. | |
WarehouseLocation | String | True | No | The location of the product within the seller's warehouse (e.g. Aisle 3, Shelf A, Bin 5). | |
WeightValue | Double | True | No | The weight value of a single item. | |
WeightUnits | String | True | No | The units of weight. | |
WeightWtUnits | Integer | True | No | A numeric value that is equivalent to the units field. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | Id of the Shipment. | |
AdvancedOptionsBillToAccount | String | True | No | Bill to Account of the shipment. | |
AdvancedOptionsBillToCountryCode | String | True | No | Bill to country code of the shipment. | |
AdvancedOptionsBillToMyOtherAccount | String | True | No | Bill to other account of the shipment. | |
AdvancedOptionsBillToParty | String | True | No | Bill to party of the shipment. | |
AdvancedOptionsBillToPostalCode | String | True | No | Bill to postal code of the shipment. | |
AdvancedOptionsContainsAlcohol | Boolean | True | No | Whether the shipment contains alcohol or not. | |
AdvancedOptionsCustomField1 | String | True | No | Custom field for shipment description. | |
AdvancedOptionsCustomField2 | String | True | No | Custom field for shipment description. | |
AdvancedOptionsCustomField3 | String | True | No | Custom field for shipment description. | |
AdvancedOptionsMergedIds | String | True | No | Merge id of the shipment. | |
AdvancedOptionsMergedOrSplit | Boolean | True | No | Merge or split the shipment. | |
AdvancedOptionsNonMachinable | Boolean | True | No | None machinable or not. | |
AdvancedOptionsParentId | Integer | True | No | Parent Id of the shipment. | |
AdvancedOptionsSaturdayDelivery | Boolean | True | No | Available for Saturday delivery or not. | |
AdvancedOptionsSource | String | True | No | Source of the shipment. | |
AdvancedOptionsStoreId | Integer | True | No | Store Id of the shipment. | |
AdvancedOptionsWarehouseId | Integer | True | No | Warehouse Id of the shipment. | |
BatchNumber | String | True | No | Batch Number of the shipment. | |
CarrierCode | String | True | No | Carrier code of the shipment. | |
Confirmation | String | True | No | Confirmation of the shipment. | |
CreateDate | Datetime | True | No | Create date of this record. | |
DimensionsHeight | Double | True | No | Height of the shipment. | |
DimensionsLength | Double | True | No | Length of the shipment. | |
DimensionsUnits | String | True | No | Units of the shipment. | |
DimensionsWidth | Double | True | No | Width of the shipment. | |
FormData | String | True | No | Form data for the shipment. | |
InsuranceCost | Double | True | No | Insurance cost of the shipment. | |
InsuranceOptionsInsuredValue | Double | True | No | Insured value of the shipment. | |
InsuranceOptionsInsureShipment | Boolean | True | No | Shipment is insured or not. | |
InsuranceOptionsProvider | String | True | No | Insurance provider of the shipment. | |
IsReturnLabel | Boolean | True | No | Shipment is return label is there or not. | |
LabelData | String | True | No | Label data of the shipment. | |
MarketplaceNotified | Boolean | True | No | Marketplace is notified or not. | |
NotifyErrorMessage | String | True | No | Error message of the notification. | |
OrderId | Integer | True | No | Order Id of the shipment. | |
OrderKey | String | True | No | Order Item key of the shipment. | |
OrderNumber | String | True | No | Order Number of the shipment. | |
PackageCode | String | True | No | Package code of the shipment. | |
ServiceCode | String | True | No | Service code of the shipment. | |
ShipDate | Date | True | No | Ship date of the shipment. | |
ShipmentCost | Double | True | No | Shipment cost. | |
ShipToCity | String | True | No | Ship to city. | |
ShipToCompany | String | True | No | Ship to company. | |
ShipToCountry | String | True | No | Ship to country. | |
ShipToName | String | True | No | Ship to Name. | |
ShipToPhone | String | True | No | Ship to phone. | |
ShipToPostalCode | String | True | No | Ship to postal code. | |
ShipToResidential | Boolean | True | No | Ship to residential. | |
ShipToState | String | True | No | Ship to state. | |
ShipToStreet1 | String | True | No | Ship to street. | |
ShipToStreet2 | String | True | No | Ship to street. | |
ShipToStreet3 | String | True | No | Ship to street. | |
TrackingNumber | String | True | No | Shipment tracking Number. | |
UserId | String | True | No | Shipment user Id. | |
VoidDate | Datetime | True | No | Void date of the shipment. | |
Voided | Boolean | True | No | Voided date of the shipment. | |
WarehouseId | Integer | True | No | Warehouse Id of the shipment. | |
WeightUnits | String | True | No | Weight units of the shipment. | |
WeightValue | Double | True | No | Weight value of the shipment. | |
WeightWtUnits | Integer | True | No | A numeric value that is equivalent to the units field. | |
RecipientName | String | False | No | Name of the Shipment Recipient Name. | |
RecipientCountryCode | String | False | No | Country code of the shipment recipient. | |
StoreId | Integer | False | No | Store Id of the shipment. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
StoreId [KEY] | Integer | True | Stores.Id | No | Id of the store. |
Id | Integer | True | No | Store refresh status id. | |
LastRefreshAttempt | Date | True | No | Last date of the refresh attempt for store. | |
RefreshDate | Date | True | No | Refresh date of the store. | |
RefreshStatus | String | True | No | Refresh status of the store. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | Id of the store. | |
AccountName | String | True | No | Account name of the store. | |
Active | Boolean | True | No | Whether store is active or not. | |
AutoRefresh | Boolean | True | No | Whether refresh is available or not. | |
CompanyName | String | True | No | Company name of the store. | |
CreateDate | Datetime | True | No | Create date of this record. | |
String | True | No | Email id of the store. | ||
IntegrationUrl | String | True | No | Integration URL of the store. | |
LastRefreshAttempt | Datetime | True | No | Last refresh attempt of the store. | |
MarketplaceId | Integer | True | No | Marketplace Id of the store. | |
MarketplaceName | String | True | No | Marketplace Name of the store. | |
ModifyDate | Datetime | True | No | Modify date of the store. | |
Phone | String | True | No | Phone number of the store. | |
PublicEmail | String | True | No | Public email of the store. | |
RefreshDate | Datetime | True | No | Refresh date of the store. | |
StatusMappings | String | True | No | ||
StoreName | String | True | No | Name of the store. | |
Website | String | True | No | Website of the store. | |
ShowInactive | Boolean | True | No | Specifies whether inactive stores will be shown. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | Globally unique ID for the tag. | |
Color | String | True | No | Color associated with this tag. | |
Name | String | True | No | Name of the tag. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Id of the User. | |
Name | String | True | No | Name of the User. | |
UserName | String | True | No | User name of the User. | |
ShowInactive | Boolean | False | No | Specifies whether inactive stores will be shown. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Integer | True | No | Id of the warehouses. | |
WarehouseName | String | True | No | Name of the warehouse. | |
CreateDate | Datetime | True | No | Create date of the record. | |
IsDefault | Boolean | True | No | Whether it is default warehouse or not. | |
OriginAddressAddressVerified | String | True | No | Origin address is verified or not. | |
OriginAddressCity | String | True | No | Origin city of the warehouse. | |
OriginAddressCompany | String | True | No | Origin country of the warehouse. | |
OriginAddressCountry | String | True | No | Origin name of the warehouse. | |
OriginAddressName | String | True | No | Origin phone of the warehouse. | |
OriginAddressPhone | String | True | No | Origin phone of the warehouse. | |
OriginAddressPostalCode | String | True | No | Origin postal code of the warehouse. | |
OriginAddressResidential | Boolean | True | No | Origin residential of the warehouse. | |
OriginAddressState | String | True | No | Origin state of the warehouse. | |
OriginAddressStreet1 | String | True | No | Origin street of the warehouse. | |
OriginAddressStreet2 | String | True | No | Origin street of the warehouse. | |
OriginAddressStreet3 | String | True | No | Origin street of the warehouse. | |
ReturnAddressAddressVerified | String | True | No | Return address is verified or not. | |
ReturnAddressCity | String | True | No | Return city of the warehouse. | |
ReturnAddressCompany | String | True | No | Return company of the warehouse. | |
ReturnAddressCountry | String | True | No | Return country of the warehouse. | |
ReturnAddressName | String | True | No | Return Name of the warehouse. | |
ReturnAddressPhone | String | True | No | Return phone of the warehouse. | |
ReturnAddressPostalCode | String | True | No | Return postal code of the warehouse. | |
ReturnAddressResidential | String | True | No | Return residential of the warehouse. | |
ReturnAddressState | String | True | No | Return state of the warehouse. | |
ReturnAddressStreet1 | String | True | No | Return street of the warehouse. | |
ReturnAddressStreet2 | String | True | No | Return street of the warehouse. | |
ReturnAddressStreet3 | String | True | No | Return street of the warehouse. |