Common Entities

Profile

PropertyType (Max Length)FilterableSortableNullableDescription
IDinteger (32 bit)YesYes Profile ID, which uniquely identifies an account
AccountNamestring (100)YesYesYesThe name of the account
CompanyNamestring (150)YesYesYesThe company name associated with the account
CurrencyCodestring (5)YesYesYesCurrency used in the account, which cannot change
TimeZoneRegionstring (50)YesYesYesTime zone of the account, which cannot change
TimeZoneDescriptionstring (50)YesYesYesDescription of the time zone
DefaultDistributionCenterIDinteger (32 bit)YesYes The distribution center assigned to products that are created without one specified
SiteAccountsSiteAccount[]Child Properties Only  The marketplace or webstore seller accounts configured in the ChannelAdvisor account
ShippingLabelPartnerAccountsShippingLabelPartnerAccount[]Child Properties Only  The shipping label partner accounts configured in the ChannelAdvisor account

Site Account

PropertyType (Max Length)FilterableSortableNullableDescription
IDinteger (32 bit)YesYes Site Account ID, which uniquely identifies a marketplace or webstore seller account configured in ChannelAdvisor
SiteAccountNamestring (255)YesYes The name of the site account
SiteIDinteger (32 bit)YesYes Identifies a marketplace or webstore
SiteNamestring (50)YesYes Name of the marketplace or webstore. See list of potential values on our Order Site ID & Site Name Values page.
EnabledbooleanYesYes Indicates if the marketplace or webstore seller account is enabled in ChannelAdvisor
ProfileProfile   Reference to the ChannelAdvisor account to which the site account belongs

Shipping Label Partner Account

PropertyType (Max Length)FilterableSortableNullableDescription
IDinteger (32 bit)YesYes Shipping Label Partner Account ID, which uniquely identifies a shipping label partner account configured in ChannelAdvisor
AccountNamestring (255)YesYes The name of the shipping label partner account
PartnerNamestring (255)YesYes The name of the shipping label partner
ProfileProfile   Reference to the ChannelAdvisor account to which the shipping label partner account belongs

Package

PropertyType (Max Length)FilterableSortableNullableDescription
IDinteger (32 bit)YesYesNo Package ID, which identifies a package configured in ChannelAdvisor in combination with ProfileID
ProfileIDinteger (32 bit)YesYesNo Uniquely identifies a ChannelAdvisor account
Namestring (50)YesYesNo The name of the package
Descriptionstring (255)YesYesYesA description of the package
ShippingCarrierstring (255)YesYesYesFor standard packages, the shipping carrier associated with the package. Null for custom packages
LengthdecimalYesYesNoThe length of the package
WidthdecimalYesYesNoThe width of the package
HeightdecimalYesYesNoThe height of the package
EmptyWeightdecimalYesYesYesThe weight of the package when empty. May be null

Distribution Center

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHDescription
IDinteger (32 bit)YesYes Read OnlyRead OnlyDistribution Center ID, which uniquely identifies a distribution center
Namestring (255)YesYesYes  Name of the distribution center, which can be changed
Codestring (255)YesYesYes Read OnlyIdentifies the distribution center and cannot be changed
FulfillmentPartnerNamestring(50)YesYes Read OnlyRead OnlyName of the fulfillment partner who manages the distribution center, if applicable. Otherwise, "None"
ContactNamestring (255)YesYesYes  Name of the point of contact for the distribution center
ContactEmailstring (255)YesYesYes  Email address of the point of contact
ContactPhonestring (255)YesYesYes  Phone number of the point of contact
Address1string (255)YesYesYes  Line 1 of the address of the distribution center
Address2string (255)YesYesYes  Line 2 of the address of the distribution center
Citystring (255)YesYesYes  City of the distribution center
StateOrProvincestring (15)YesYesYes  Region of the distribution center
Countrystring (2)YesYesYes  Country of the distribution center
PostalCodestring (25)YesYesYes  Postal code of the distribution center
PickupLocationbooleanYesYes   Indicates if the distribution center allows buyer pickup
ShipLocationbooleanYesYes   Indicates if the distribution center is a shipping location
TypeenumYesYes   Type of distribution center
IsExternallyManagedbooleanYesYes Read OnlyRead OnlyIndicates if the distribution center is externally managed, e.g. Fulfillment By Amazon
IsDeletedbooleanYesYes Read OnlyRead OnlyIndicates if the distribution center has been deleted
DeletedDateUtcDateTimeOffsetYesYesYesRead OnlyRead OnlyDate the distribution center was deleted