--- schema_version: "1" id: 9d302de3f49ede4134dad6f1f540668a9dbea47b29e0ed526fa1d0f69145c4ef title: Adobe Commerce Connector Objects collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/data-cloud/data-cloud-int/guides/adobecommerce/c360-a-adobecommerce-objects.md canonical_url: https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-adobecommerce-objects.html source_site: developer.salesforce.com content_type: documentation content_hash: d81a013fc0437fbf1eb9979116d0c8a8203e10eb1b15beec542547a49122d22b products: - Data 360 Integration Guide - Data 360 Developer Documentation --- # Adobe Commerce Connector Objects **note:** This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms.](https://www.salesforce.com/company/legal/agreements/) If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at [datacloud-connectors-beta@salesforce.com.](mailto:datacloud-connectors-beta@salesforce.com) ## Objects Supported | Name | Description | | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | [AdobeStockAssetApiAsset](#adobestockassetapiasset) | AdobeStockAssetApiAsset is an auto generated table | | [AdobeStockAssetApiGetAssetList](#adobestockassetapigetassetlist) | AdobeStockAssetApiGetAssetList is an auto generated table | | [AdobeStockImageApiGetImageList](#adobestockimageapigetimagelist) | AdobeStockImageApiGetImageList is an auto generated table | | [AnalyticsLinkProvider](#analyticslinkprovider) | AnalyticsLinkProvider is an auto generated table | | [AsynchronousOperationsBulkStatus](#asynchronousoperationsbulkstatus) | AsynchronousOperationsBulkStatus is an auto generated table | | [AsynchronousOperationsOperation](#asynchronousoperationsoperation) | AsynchronousOperationsOperation is an auto generated table | | [BillingAddresses](#billingaddresses) | BillingAddresses is an auto-generated table. The supported operations are Querying data from this table. | | [BundleProductLinkChildren](#bundleproductlinkchildren) | BundleProductLinkChildren is an auto generated table. The supported operations are Querying data from this table. | | [BundleProductOption](#bundleproductoption) | BundleProductOption is an auto generated table. The supported operations are Delete, and Querying data from this table. | | [CatalogAttributeSet](#catalogattributeset) | CatalogAttributeSet is an auto generated table. The supported operations are Update, Delete, and Querying data from this table. | | [CatalogCategoryAttribute](#catalogcategoryattribute) | CatalogCategoryAttribute is an auto generated table. The supported operations are Querying data from this table. | | [CatalogCategoryAttributeOptionOptions](#catalogcategoryattributeoptionoptions) | CatalogCategoryAttributeOptionOptions is an auto generated table. The supported operations are Querying data from this table. | | [CatalogCategoryLinkProducts](#catalogcategorylinkproducts) | CatalogCategoryLinkProducts is an auto generated table. The supported operations are Querying data from this table. | | [CatalogCategoryList](#catalogcategorylist) | CatalogCategoryList is an auto generated table | | [CatalogProductAttribute](#catalogproductattribute) | CatalogProductAttribute is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [CatalogProductAttributeTypesList](#catalogproductattributetypeslist) | CatalogProductAttributeTypesList is an auto generated table. The supported operations are Querying data from this table. | | [CatalogProductLinkTypeList](#catalogproductlinktypelist) | CatalogProductLinkTypeList is an auto generated table. The supported operations are Querying data from this table. | | [CatalogProductRenderList](#catalogproductrenderlist) | CatalogProductRenderList is an auto generated table | | [CatalogProductTierPriceTiers](#catalogproducttierpricetiers) | CatalogProductTierPriceTiers is an auto generated table. The supported operations are Querying data from this table. | | [CatalogProductTypeList](#catalogproducttypelist) | CatalogProductTypeList is an auto generated table. The supported operations are Querying data from this table. | | [CheckoutAgreementsCheckoutAgreements](#checkoutagreementscheckoutagreements) | CheckoutAgreementsCheckoutAgreements is an auto generated table. The supported operations are Querying data from this table. | | [CheckoutAgreementsCheckoutAgreementsList](#checkoutagreementscheckoutagreementslist) | CheckoutAgreementsCheckoutAgreementsList is an auto generated table | | [CmsBlock](#cmsblock) | CmsBlock is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [CmsPage](#cmspage) | CmsPage is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [ConfigurableProductLinkChildren](#configurableproductlinkchildren) | ConfigurableProductLinkChildren is an auto generated table. The supported operations are Querying data from this table. | | [ConfigurableProductOption](#configurableproductoption) | ConfigurableProductOption is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [CustomerAccountBillingAddress](#customeraccountbillingaddress) | CustomerAccountBillingAddress is an auto generated table. The supported operations are Querying data from this table. | | [CustomerAccountShippingAddress](#customeraccountshippingaddress) | CustomerAccountShippingAddress is an auto generated table. The supported operations are Querying data from this table. | | [CustomerAddress](#customeraddress) | CustomerAddress is an auto generated table. The supported operations are Delete, and Querying data from this table. | | [CustomerGroup](#customergroup) | CustomerGroup is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [CustomerGroupDefault](#customergroupdefault) | CustomerGroupDefault is an auto generated table. The supported operations are Querying data from this table. | | [Customers](#customers) | Customers is an auto generated table. The supported operations are Update, Delete, and Querying data from this table. | | [DirectoryCountryInformationAcquirer](#directorycountryinformationacquirer) | DirectoryCountryInformationAcquirer is an auto generated table. The supported operations are Querying data from this table. | | [DirectoryCurrencyInformationAcquirer](#directorycurrencyinformationacquirer) | DirectoryCurrencyInformationAcquirer is an auto generated table. The supported operations are Querying data from this table. | | [DownloadableLink](#downloadablelink) | DownloadableLink is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [DownloadableSample](#downloadablesample) | DownloadableSample is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [EavAttributeSet](#eavattributeset) | EavAttributeSet is an auto generated table. The supported operations are Update, Delete, and Querying data from this table. | | [GiftMessageCart](#giftmessagecart) | GiftMessageCart is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [GiftMessageGuestCart](#giftmessageguestcart) | GiftMessageGuestCart is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [GiftMessageGuestItem](#giftmessageguestitem) | GiftMessageGuestItem is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [GiftMessageItem](#giftmessageitem) | GiftMessageItem is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [GuestBillingAddresses](#guestbillingaddresses) | GuestBillingAddresses is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [GuestPaymentInformation](#guestpaymentinformation) | GuestPaymentInformation is an auto generated table. The supported operations are Querying data from this table. | | [GuestPaymentMethods](#guestpaymentmethods) | GuestPaymentMethods is an auto generated table. The supported operations are Querying data from this table. | | [GuestPaymentSelectedMethods](#guestpaymentselectedmethods) | GuestPaymentSelectedMethods is an auto generated table. The supported operations are Querying data from this table. | | [GuestShippingMethods](#guestshippingmethods) | GuestShippingMethods is an auto generated table. The supported operations are Querying data from this table. | | [Inventory](#inventory) | Inventory is an auto generated table. The supported operations are Update, and Querying data from this table. | | [InventoryApiGetSourcesAssignedToStockOrderedByPriority](#inventoryapigetsourcesassignedtostockorderedbypriority) | InventoryApiGetSourcesAssignedToStockOrderedByPriority is an auto generated table | | [InventoryApiGetStockSourceLinks](#inventoryapigetstocksourcelinks) | InventoryApiGetStockSourceLinks is an auto generated table | | [InventoryApiSource](#inventoryapisource) | InventoryApiSource is an auto generated table | | [InventoryApiSourceItem](#inventoryapisourceitem) | InventoryApiSourceItem is an auto generated table | | [InventoryApiStock](#inventoryapistock) | InventoryApiStock is an auto generated table | | [OrderComments](#ordercomments) | OrderComments is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [OrderItems](#orderitems) | OrderItems is an auto generated table. The supported operations are Querying data from this table. | | [Orders](#orders) | Orders is an auto generated table. The supported operations are Insert, Update, and Querying data from this table. | | [PaymentMethods](#paymentmethods) | PaymentMethods is an auto generated table. The supported operations are Querying data from this table. | | [PaymentSelectedMethods](#paymentselectedmethods) | PaymentSelectedMethods is an auto generated table. The supported operations are Querying data from this table. | | [PayPalBraintreeAuth](#paypalbraintreeauth) | PayPalBraintreeAuth is an auto generated table | | [ProductAttributeGroup](#productattributegroup) | ProductAttributeGroup is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [ProductAttributeOptions](#productattributeoptions) | ProductAttributeOptions is an auto generated table. The supported operations are Insert, Delete, and Querying data from this table. | | [ProductAttributes](#productattributes) | ProductAttributes is an auto generated table. The supported operations are Querying data from this table. | | [ProductCategories](#productcategories) | ProductCategories is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [ProductCustomOption](#productcustomoption) | ProductCustomOption is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [ProductMedia](#productmedia) | ProductMedia is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [Products](#products) | Products is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [QuoteCart](#quotecart) | QuoteCart is an auto generated table. The supported operations are Update, and Querying data from this table. | | [QuoteCartItem](#quotecartitem) | QuoteCartItem is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [QuoteCartTotal](#quotecarttotal) | QuoteCartTotal is an auto generated table. The supported operations are Querying data from this table. | | [QuoteGuestCart](#quoteguestcart) | QuoteGuestCart is an auto generated table. The supported operations are Querying data from this table. | | [QuoteGuestCartItem](#quoteguestcartitem) | QuoteGuestCartItem is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [QuoteGuestCartTotal](#quoteguestcarttotal) | QuoteGuestCartTotal is an auto generated table. The supported operations are Querying data from this table. | | [SalesCreditmemo](#salescreditmemo) | SalesCreditmemo is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [SalesCreditmemoComments](#salescreditmemocomments) | SalesCreditmemoComments is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [SalesInvoice](#salesinvoice) | SalesInvoice is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [SalesInvoiceComments](#salesinvoicecomments) | SalesInvoiceComments is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [SalesRule](#salesrule) | SalesRule is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [SalesRuleCoupon](#salesrulecoupon) | SalesRuleCoupon is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [SalesShipment](#salesshipment) | SalesShipment is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [SalesShipmentComments](#salesshipmentcomments) | SalesShipmentComments is an auto generated table. The supported operations are Insert, and Querying data from this table. | | [SalesTransaction](#salestransaction) | SalesTransaction is an auto generated table. The supported operations are Querying data from this table. | | [ShippingMethods](#shippingmethods) | ShippingMethods is an auto generated table. The supported operations are Querying data from this table. | | [StoreGroup](#storegroup) | StoreGroup is an auto generated table. The supported operations are Querying data from this table. | | [Stores](#stores) | Stores is an auto generated table. The supported operations are Querying data from this table. | | [StoreWebsite](#storewebsite) | StoreWebsite is an auto generated table. The supported operations are Querying data from this table. | | [TaxClass](#taxclass) | TaxClass is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [TaxRate](#taxrate) | TaxRate is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | | [TaxRule](#taxrule) | TaxRule is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. | ## AdobeStockAssetApiAsset | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | ID | | Category | String | False | | No | This is an auto-generated column | | CategoryId | Int | False | | No | Category | | CreationDate | String | False | | No | Creation date | | Creator | String | False | | No | This is an auto-generated column | | CreatorId | Int | False | | No | The creator | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsLicensed | Int | False | | No | Licensed | | MediaGalleryId | Int | False | | No | Media gallery asset id | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## AdobeStockAssetApiGetAssetList | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | This is an auto-generated column | | Aggregations | String | False | | No | This is an auto-generated column | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## AdobeStockImageApiGetImageList | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | This is an auto-generated column | | Aggregations | String | False | | No | This is an auto-generated column | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## AnalyticsLinkProvider | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | InitializationVector | String | False | | No | This is an auto-generated column | | Url | String | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## AsynchronousOperationsBulkStatus | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | ---------------------------------------------------------- | | BulkId | String | False | | No | Bulk uuid | | BulkUuid | String | False | | No | bulkUuid | | Description | String | False | | No | Bulk description | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | OperationCount | Int | False | | No | Total number of operations scheduled in scope of this bulk | | OperationsList | String | False | | No | Operations list. | | StartTime | String | False | | No | Bulk scheduled time | | UserId | Int | False | | No | User id | | UserType | Int | False | | No | User type | [Return to Top](#objects-supported) ## AsynchronousOperationsOperation | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Id | | BulkUuid | String | False | | No | Bulk uuid | | ErrorCode | Int | False | | No | Error code | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | ResultMessage | String | False | | No | Result message | | ResultSerializedData | String | False | | No | Serialized Data | | SearchCriteria | String | False | | No | This is an auto-generated column | | SerializedData | String | False | | No | Data | | Status | Int | False | | No | Operation status | | TopicName | String | False | | No | Queue Topic | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## BillingAddresses | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Id | | CartId | String | False | | No | cartId | | City | String | False | | No | City name | | Company | String | False | | No | Company | | CountryId | String | False | | No | Country id | | CustomerAddressId | Int | False | | No | Customer address id | | CustomerId | Int | False | | No | Customer id | | Email | String | False | | No | Billing/shipping email | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Fax | String | False | | No | Fax number | | Firstname | String | False | | No | First name | | Lastname | String | False | | No | Last name | | Middlename | String | False | | No | Middle name | | Postcode | String | False | | No | Postcode | | Prefix | String | False | | No | Prefix | | Region | String | False | | No | Region name | | RegionCode | String | False | | No | Region code | | RegionId | Int | False | | No | Region id | | SameAsBilling | Int | False | | No | Same as billing flag | | SaveInAddressBook | Int | False | | No | Save in address book flag | | Street | String | False | | No | Street | | Suffix | String | False | | No | Suffix | | Telephone | String | False | | No | Telephone number | | VatId | String | False | | No | Vat id | [Return to Top](#objects-supported) ## BundleProductLinkChildren | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | --------------------------------- | | Id [KEY] | String | False | | No | The identifier | | ProductSku | String | False | | No | productSku | | CanChangeQuantity | Int | False | | No | Whether quantity could be changed | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsDefault | Bool | False | | No | Is default | | OptionId | Int | False | | No | Option id | | Position | Int | False | | No | Position | | Price | Double | False | | No | Price | | PriceType | Int | False | | No | Price type | | Qty | Double | False | | No | Qty | | Sku | String | False | | No | Linked product sku | [Return to Top](#objects-supported) ## BundleProductOption | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | OptionId [KEY] | Int | False | | No | Option id | | Position | Int | False | | No | Option position | | ProductLinks | String | False | | No | Product links | | Required | Bool | False | | No | Is required option | | Sku [KEY] | String | False | | No | Product sku | | Title | String | False | | No | Option title | | Type | String | False | | No | Input type | [Return to Top](#objects-supported) ## CatalogAttributeSet | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | AttributeSetId [KEY] | Int | False | | No | Attribute set ID | | AttributeSetName | String | False | | No | Attribute set name | | EntityTypeId | Int | False | | No | Attribute set entity type id | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | SearchCriteria | String | False | | No | This is an auto-generated column | | SortOrder | Int | False | | No | Attribute set sort order index | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## CatalogCategoryAttribute | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------- | ------ | -------- | ---------- | ---------- | -------------------------------------------------------- | | ApplyTo | String | False | | No | Apply to value for the element | | AttributeCode | String | False | | No | Code of the attribute. | | AttributeId [KEY] | Int | False | | No | Id of the attribute. | | BackendModel | String | False | | No | Backend model | | BackendType | String | False | | No | Backend type. | | DefaultFrontendLabel | String | False | | No | Frontend label for default store | | DefaultValue | String | False | | No | Default value for the element. | | EntityTypeId | String | False | | No | Entity type id | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | FrontendClass | String | False | | No | Frontend class of attribute | | FrontendInput | String | False | | No | HTML for input element. | | FrontendLabels | String | False | | No | Frontend label for each store | | IsComparable | String | False | | No | The attribute can be compared on the frontend | | IsFilterable | Bool | False | | No | It used in layered navigation | | IsFilterableInGrid | Bool | False | | No | It is filterable in catalog product grid | | IsFilterableInSearch | Bool | False | | No | It is used in search results layered navigation | | IsHtmlAllowedOnFront | Bool | False | | No | The HTML tags are allowed on the frontend | | IsRequired | Bool | False | | No | Attribute is required. | | IsSearchable | String | False | | No | The attribute can be used in Quick Search | | IsUnique | String | False | | No | This is a unique attribute | | IsUsedForPromoRules | String | False | | No | The attribute can be used for promo rules | | IsUsedInGrid | Bool | False | | No | It is used in catalog product grid | | IsUserDefined | Bool | False | | No | Current attribute has been defined by a user. | | IsVisible | Bool | False | | No | Attribute is visible on frontend. | | IsVisibleInAdvancedSearch | String | False | | No | The attribute can be used in Advanced Search | | IsVisibleInGrid | Bool | False | | No | It is visible in catalog product grid | | IsVisibleOnFront | String | False | | No | The attribute is visible on the frontend | | IsWysiwygEnabled | Bool | False | | No | WYSIWYG flag | | Note | String | False | | No | The note attribute for the element. | | Options | String | False | | No | Options of the attribute (key => value pairs for select) | | Position | Int | False | | No | Position | | Scope | String | False | | No | Attribute scope | | SearchCriteria | String | False | | No | This is an auto-generated column | | SourceModel | String | False | | No | Source model | | TotalCount | Int | False | | No | Total count. | | UsedForSortBy | Bool | False | | No | It is used for sorting in product listing | | UsedInProductListing | String | False | | No | The attribute can be used in product listing | | ValidationRules | String | False | | No | Validation rules. | [Return to Top](#objects-supported) ## CatalogCategoryAttributeOptionOptions | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------- | ------ | -------- | ---------- | ---------- | ----------------------------- | | IsDefault | Bool | False | | No | Default | | AttributeCode | String | False | | No | attributeCode | | Label [KEY] | String | False | | No | Option label | | SortOrder | Int | False | | No | Option order | | StoreLabels | String | False | | No | Option label for store scopes | | Value | String | False | | No | Option value | [Return to Top](#objects-supported) ## CatalogCategoryLinkProducts | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | CategoryId | String | False | | No | Category id | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Position | Int | False | | No | This is an auto-generated column | | Sku [KEY] | String | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## CatalogCategoryList | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ----------------------------------- | | Id [KEY] | Int | False | | No | Category id. | | AvailableSortBy | String | False | | No | Available sort by for category. | | Children | String | False | | No | Children ids comma separated. | | CreatedAt | Datetime | False | | No | Category creation date and time. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IncludeInMenu | Bool | False | | No | Category is included in menu. | | IsActive | Bool | False | | No | Whether category is active | | Level | Int | False | | No | Category level | | Name | String | False | | No | Category name | | ParentId | Int | False | | No | Parent category ID | | Path | String | False | | No | Category full path. | | Position | Int | False | | No | Category position | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | | UpdatedAt | Datetime | False | | No | Category last update date and time. | [Return to Top](#objects-supported) ## CatalogProductAttribute | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------- | ------ | -------- | ---------- | ---------- | -------------------------------------------------------- | | ApplyTo | String | False | | No | Apply to value for the element | | AttributeCode [KEY] | String | False | | No | Code of the attribute. | | AttributeId | Int | False | | No | Id of the attribute. | | BackendModel | String | False | | No | Backend model | | BackendType | String | False | | No | Backend type. | | DefaultFrontendLabel | String | False | | No | Frontend label for default store | | DefaultValue | String | False | | No | Default value for the element. | | EntityTypeId | String | False | | No | Entity type id | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | FrontendClass | String | False | | No | Frontend class of attribute | | FrontendInput | String | False | | No | HTML for input element. | | FrontendLabels | String | False | | No | Frontend label for each store | | IsComparable | String | False | | No | The attribute can be compared on the frontend | | IsFilterable | Bool | False | | No | It used in layered navigation | | IsFilterableInGrid | Bool | False | | No | It is filterable in catalog product grid | | IsFilterableInSearch | Bool | False | | No | It is used in search results layered navigation | | IsHtmlAllowedOnFront | Bool | False | | No | The HTML tags are allowed on the frontend | | IsRequired | Bool | False | | No | Attribute is required. | | IsSearchable | String | False | | No | The attribute can be used in Quick Search | | IsUnique | String | False | | No | This is a unique attribute | | IsUsedForPromoRules | String | False | | No | The attribute can be used for promo rules | | IsUsedInGrid | Bool | False | | No | It is used in catalog product grid | | IsUserDefined | Bool | False | | No | Current attribute has been defined by a user. | | IsVisible | Bool | False | | No | Attribute is visible on frontend. | | IsVisibleInAdvancedSearch | String | False | | No | The attribute can be used in Advanced Search | | IsVisibleInGrid | Bool | False | | No | It is visible in catalog product grid | | IsVisibleOnFront | String | False | | No | The attribute is visible on the frontend | | IsWysiwygEnabled | Bool | False | | No | WYSIWYG flag | | Note | String | False | | No | The note attribute for the element. | | Options | String | False | | No | Options of the attribute (key => value pairs for select) | | Position | Int | False | | No | Position | | Scope | String | False | | No | Attribute scope | | SourceModel | String | False | | No | Source model | | UsedForSortBy | Bool | False | | No | It is used for sorting in product listing | | UsedInProductListing | String | False | | No | The attribute can be used in product listing | | ValidationRules | String | False | | No | Validation rules. | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## CatalogProductAttributeTypesList | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Label [KEY] | String | False | | No | Type label | | Value | String | False | | No | Value | [Return to Top](#objects-supported) ## CatalogProductLinkTypeList | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Code [KEY] | Int | False | | No | Link type code | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Name | String | False | | No | Link type name | | Type | String | False | | No | Attribute type | [Return to Top](#objects-supported) ## CatalogProductRenderList | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------------------------------- | | Id [KEY] | Int | False | | No | Product identifier | | AddToCartButton | String | False | | No | This is an auto-generated column | | AddToCompareButton | String | False | | No | This is an auto-generated column | | CurrencyCode | String | False | | No | Current or desired currency code to product | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Images | String | False | | No | Enough information, that needed to render image on front | | IsSalable | String | False | | No | Information about product saleability (In Stock) | | Name | String | False | | No | Product name | | PriceInfo | String | False | | No | This is an auto-generated column | | StoreId | Int | False | | No | Information about current store id or requested store id | | Type | String | False | | No | Product type. Such as bundle, grouped, simple, etc... | | Url | String | False | | No | Product url | [Return to Top](#objects-supported) ## CatalogProductTierPriceTiers | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | CustomerGroupId [KEY] | Int | False | | No | Customer group id | | Sku | String | False | | No | sku | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Qty | Double | False | | No | Tier qty | | Value | Double | False | | No | Price value | [Return to Top](#objects-supported) ## CatalogProductTypeList | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Label [KEY] | String | False | | No | Product type label | | Name | String | False | | No | Product type code | [Return to Top](#objects-supported) ## CheckoutAgreementsCheckoutAgreements | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------ | | AgreementId [KEY] | Int | False | | No | Agreement ID. | | CheckboxText | String | False | | No | Agreement checkbox text. | | Content | String | False | | No | Agreement content. | | ContentHeight | String | False | | No | Agreement content height. Otherwise, null. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsActive | Bool | False | | No | Agreement status. | | IsHtml | Bool | False | | No | _ true - HTML. _ false - plain text. | | Mode | Int | False | | No | The agreement applied mode. | | Name | String | False | | No | Agreement name. | [Return to Top](#objects-supported) ## CheckoutAgreementsCheckoutAgreementsList | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------ | | AgreementId | Int | False | | No | Agreement ID. | | CheckboxText | String | False | | No | Agreement checkbox text. | | Content | String | False | | No | Agreement content. | | ContentHeight | String | False | | No | Agreement content height. Otherwise, null. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsActive | Bool | False | | No | Agreement status. | | IsHtml | Bool | False | | No | _ true - HTML. _ false - plain text. | | Mode | Int | False | | No | The agreement applied mode. | | Name | String | False | | No | Agreement name. | [Return to Top](#objects-supported) ## CmsBlock | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | ID | | BlockId | String | False | | No | blockId | | Active | Bool | False | | No | Active | | Content | String | False | | No | Content | | CreationTime | String | False | | No | Creation time | | Identifier | String | False | | No | Identifier | | Title | String | False | | No | Title | | UpdateTime | String | False | | No | Update time | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## CmsPage | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | ID | | PageId | String | False | | No | pageId | | Active | Bool | False | | No | Active | | Content | String | False | | No | Content | | ContentHeading | String | False | | No | Content heading | | CreationTime | String | False | | No | Creation time | | CustomLayoutUpdateXml | String | False | | No | Custom layout update xml | | CustomRootTemplate | String | False | | No | Custom root template | | CustomTheme | String | False | | No | Custom theme | | CustomThemeFrom | String | False | | No | Custom theme from | | CustomThemeTo | String | False | | No | Custom theme to | | Identifier | String | False | | No | Identifier | | LayoutUpdateXml | String | False | | No | Layout update xml | | MetaDescription | String | False | | No | Meta description | | MetaKeywords | String | False | | No | Meta keywords | | MetaTitle | String | False | | No | Meta title | | PageLayout | String | False | | No | Page layout | | SortOrder | String | False | | No | Sort order | | Title | String | False | | No | Title | | UpdateTime | String | False | | No | Update time | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## ConfigurableProductLinkChildren | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Id | | AttributeSetId | Int | False | | No | Attribute set id | | CreatedAt | Datetime | False | | No | Created date | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | MediaGalleryEntries | String | False | | No | Media gallery entries | | Name | String | False | | No | Name | | Options | String | False | | No | List of product options | | Price | Double | False | | No | Price | | ProductLinks | String | False | | No | Product links info | | Sku | String | False | | No | Sku | | Status | Int | False | | No | Status | | TierPrices | String | False | | No | List of product tier prices | | TypeId | String | False | | No | Type id | | UpdatedAt | Datetime | False | | No | Updated date | | Visibility | Int | False | | No | Visibility | | Weight | Double | False | | No | Weight | [Return to Top](#objects-supported) ## ConfigurableProductOption | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | This is an auto-generated column | | Sku | String | False | | No | sku | | AttributeId | String | False | | No | This is an auto-generated column | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsUseDefault | Bool | False | | No | This is an auto-generated column | | Label | String | False | | No | This is an auto-generated column | | Position | Int | False | | No | This is an auto-generated column | | ProductId | Int | False | | No | This is an auto-generated column | | Values | String | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## CustomerAccountBillingAddress | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------------------- | | Id [KEY] | Int | False | | No | ID | | City | String | False | | No | City name | | Company | String | False | | No | Company | | CountryId | String | False | | No | Country code in ISO_3166-2 format | | CustomerId | Int | False | | No | Customer ID | | DefaultBilling | Bool | False | | No | If this address is default billing address | | DefaultShipping | Bool | False | | No | If this address is default shipping address. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Fax | String | False | | No | Fax number | | Firstname | String | False | | No | First name | | Lastname | String | False | | No | Last name | | Middlename | String | False | | No | Middle name | | Postcode | String | False | | No | Postcode | | Prefix | String | False | | No | Prefix | | Region | String | False | | No | This is an auto-generated column | | RegionId | Int | False | | No | Region ID | | Street | String | False | | No | Street | | Suffix | String | False | | No | Suffix | | Telephone | String | False | | No | Telephone number | | VatId | String | False | | No | Vat id | [Return to Top](#objects-supported) ## CustomerAccountShippingAddress | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------------------- | | Id [KEY] | Int | False | | No | ID | | City | String | False | | No | City name | | Company | String | False | | No | Company | | CountryId | String | False | | No | Country code in ISO_3166-2 format | | CustomerId | Int | False | | No | Customer ID | | DefaultBilling | Bool | False | | No | If this address is default billing address | | DefaultShipping | Bool | False | | No | If this address is default shipping address. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Fax | String | False | | No | Fax number | | Firstname | String | False | | No | First name | | Lastname | String | False | | No | Last name | | Middlename | String | False | | No | Middle name | | Postcode | String | False | | No | Postcode | | Prefix | String | False | | No | Prefix | | Region | String | False | | No | This is an auto-generated column | | RegionId | Int | False | | No | Region ID | | Street | String | False | | No | Street | | Suffix | String | False | | No | Suffix | | Telephone | String | False | | No | Telephone number | | VatId | String | False | | No | Vat id | [Return to Top](#objects-supported) ## CustomerAddress | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------------------- | | Id [KEY] | Int | False | | No | ID | | AddressId | String | False | | No | addressId | | City | String | False | | No | City name | | Company | String | False | | No | Company | | CountryId | String | False | | No | Country code in ISO_3166-2 format | | CustomerId | Int | False | | No | Customer ID | | DefaultBilling | Bool | False | | No | If this address is default billing address | | DefaultShipping | Bool | False | | No | If this address is default shipping address. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Fax | String | False | | No | Fax number | | Firstname | String | False | | No | First name | | Lastname | String | False | | No | Last name | | Middlename | String | False | | No | Middle name | | Postcode | String | False | | No | Postcode | | Prefix | String | False | | No | Prefix | | Region | String | False | | No | This is an auto-generated column | | RegionId | Int | False | | No | Region ID | | Street | String | False | | No | Street | | Suffix | String | False | | No | Suffix | | Telephone | String | False | | No | Telephone number | | VatId | String | False | | No | Vat id | [Return to Top](#objects-supported) ## CustomerGroup | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Id | | Code | String | False | | No | Code | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | TaxClassId | Int | False | | No | Tax class id | | TaxClassName | String | False | | No | Tax class name | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## CustomerGroupDefault | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Id | | Code | String | False | | No | Code | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | TaxClassId | Int | False | | No | Tax class id | | TaxClassName | String | False | | No | Tax class name | [Return to Top](#objects-supported) ## Customers | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------------- | -------- | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Customer id | | Addresses | String | False | | No | Customer addresses. | | Confirmation | String | False | | No | Confirmation | | CreatedAt | Datetime | False | | No | Created at time | | CreatedIn | String | False | | No | Created in area | | DefaultBilling | String | False | | No | Default billing address id | | DefaultShipping | String | False | | No | Default shipping address id | | DisableAutoGroupChange | Int | False | | No | Disable auto group change flag. | | Dob | String | False | | No | Date of birth | | Email | String | False | | No | Email address | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Firstname | String | False | | No | First name | | Gender | Int | False | | No | Gender | | GroupId | Int | False | | No | Group id | | Lastname | String | False | | No | Last name | | Middlename | String | False | | No | Middle name | | Prefix | String | False | | No | Prefix | | StoreId | Int | False | | No | Store id | | Suffix | String | False | | No | Suffix | | Taxvat | String | False | | No | Tax Vat | | UpdatedAt | Datetime | False | | No | Updated at time | | WebsiteId | Int | False | | No | Website id | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## DirectoryCountryInformationAcquirer | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------------ | | Id [KEY] | String | False | | No | The country id for the store. | | CountryId | String | False | | No | countryId | | AvailableRegions | String | False | | No | The available regions for the store. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | FullNameEnglish | String | False | | No | The country full name (in English) for the store. | | FullNameLocale | String | False | | No | The country full name (in store locale) for the store. | | ThreeLetterAbbreviation | String | False | | No | The country 3 letter abbreviation for the store. | | TwoLetterAbbreviation | String | False | | No | The country 2 letter abbreviation for the store. | [Return to Top](#objects-supported) ## DirectoryCurrencyInformationAcquirer | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------------------------ | | AvailableCurrencyCodes | String | False | | No | The list of allowed currency codes for the store. | | BaseCurrencyCode [KEY] | String | False | | No | The base currency code for the store. | | BaseCurrencySymbol | String | False | | No | The currency symbol of the base currency for the store. | | DefaultDisplayCurrencyCode | String | False | | No | The default display currency code for the store. | | DefaultDisplayCurrencySymbol | String | False | | No | The currency symbol of the default display currency for the store. | | ExchangeRates | String | False | | No | The list of exchange rate information for the store. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## DownloadableLink | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------ | | Id [KEY] | Int | False | | No | Sample(or link) id | | Sku | String | False | | No | sku | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsShareable | Int | False | | No | Shareable status | | LinkFile | String | False | | No | relative file path | | LinkFileContent | String | False | | No | This is an auto-generated column | | LinkType | String | False | | No | This is an auto-generated column | | LinkUrl | String | False | | No | Link url or null when type is 'file' | | NumberOfDownloads | Int | False | | No | Of downloads per user | | Price | Double | False | | No | Price | | SampleFile | String | False | | No | relative file path | | SampleFileContent | String | False | | No | This is an auto-generated column | | SampleType | String | False | | No | This is an auto-generated column | | SampleUrl | String | False | | No | file URL | | SortOrder | Int | False | | No | This is an auto-generated column | | Title | String | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## DownloadableSample | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Sample(or link) id | | Sku | String | False | | No | sku | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | SampleFile | String | False | | No | relative file path | | SampleFileContent | String | False | | No | This is an auto-generated column | | SampleType | String | False | | No | This is an auto-generated column | | SampleUrl | String | False | | No | file URL | | SortOrder | Int | False | | No | Order index for sample | | Title | String | False | | No | Title | [Return to Top](#objects-supported) ## EavAttributeSet | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | AttributeSetId [KEY] | Int | False | | No | Attribute set ID | | AttributeSetName | String | False | | No | Attribute set name | | EntityTypeId | Int | False | | No | Attribute set entity type id | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | SearchCriteria | String | False | | No | This is an auto-generated column | | SortOrder | Int | False | | No | Attribute set sort order index | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## GiftMessageCart | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | --------------------------------- | | CustomerId | Int | False | | No | Customer ID. Otherwise, null. | | CartId | String | False | | No | cartId | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | GiftMessageId [KEY] | Int | False | | No | Gift message ID. Otherwise, null. | | Message | String | False | | No | Message text. | | Recipient | String | False | | No | Recipient name. | | Sender | String | False | | No | Sender name. | [Return to Top](#objects-supported) ## GiftMessageGuestCart | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | --------------------------------- | | CustomerId | Int | False | | No | Customer ID. Otherwise, null. | | CartId | String | False | | No | cartId | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | GiftMessageId [KEY] | Int | False | | No | Gift message ID. Otherwise, null. | | Message | String | False | | No | Message text. | | Recipient | String | False | | No | Recipient name. | | Sender | String | False | | No | Sender name. | [Return to Top](#objects-supported) ## GiftMessageGuestItem | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | --------------------------------- | | CustomerId | Int | False | | No | Customer ID. Otherwise, null. | | CartId | String | False | | No | cartId | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | GiftMessageId [KEY] | Int | False | | No | Gift message ID. Otherwise, null. | | Message | String | False | | No | Message text. | | Recipient | String | False | | No | Recipient name. | | Sender | String | False | | No | Sender name. | [Return to Top](#objects-supported) ## GiftMessageItem | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | --------------------------------- | | CustomerId | Int | False | | No | Customer ID. Otherwise, null. | | CartId | String | False | | No | cartId | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | GiftMessageId [KEY] | Int | False | | No | Gift message ID. Otherwise, null. | | Message | String | False | | No | Message text. | | Recipient | String | False | | No | Recipient name. | | Sender | String | False | | No | Sender name. | [Return to Top](#objects-supported) ## GuestBillingAddresses | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Id | | CartId | String | False | | No | cartId | | City | String | False | | No | City name | | Company | String | False | | No | Company | | CountryId | String | False | | No | Country id | | CustomerAddressId | Int | False | | No | Customer address id | | CustomerId | Int | False | | No | Customer id | | Email | String | False | | No | Billing/shipping email | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Fax | String | False | | No | Fax number | | Firstname | String | False | | No | First name | | Lastname | String | False | | No | Last name | | Middlename | String | False | | No | Middle name | | Postcode | String | False | | No | Postcode | | Prefix | String | False | | No | Prefix | | Region | String | False | | No | Region name | | RegionCode | String | False | | No | Region code | | RegionId | Int | False | | No | Region id | | SameAsBilling | Int | False | | No | Same as billing flag | | SaveInAddressBook | Int | False | | No | Save in address book flag | | Street | String | False | | No | Street | | Suffix | String | False | | No | Suffix | | Telephone | String | False | | No | Telephone number | | VatId | String | False | | No | Vat id | [Return to Top](#objects-supported) ## GuestPaymentInformation | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | CartId | String | False | | No | cartId | | PaymentMethods | String | False | | No | This is an auto-generated column | | Totals | String | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## GuestPaymentMethods | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------- | ------ | -------- | ---------- | ---------- | -------------------- | | Code [KEY] | String | False | | No | Payment method code | | CartId | String | False | | No | cartId | | Title | String | False | | No | Payment method title | [Return to Top](#objects-supported) ## GuestPaymentSelectedMethods | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | AdditionalData | String | False | | No | Payment additional details | | CartId | String | False | | No | cartId | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Method [KEY] | String | False | | No | Payment method code | | PoNumber | String | False | | No | Purchase order number | [Return to Top](#objects-supported) ## GuestShippingMethods | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------------------------- | | Amount | Double | False | | No | Shipping amount in store currency. | | CartId | String | False | | No | cartId | | Available | Bool | False | | No | The value of the availability flag for the current shipping method. | | BaseAmount | Double | False | | No | Shipping amount in base currency. | | CarrierCode | String | False | | No | Shipping carrier code. | | CarrierTitle | String | False | | No | Shipping carrier title. Otherwise, null. | | ErrorMessage | String | False | | No | Shipping Error message. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | MethodCode [KEY] | String | False | | No | Shipping method code. | | MethodTitle | String | False | | No | Shipping method title. Otherwise, null. | | PriceExclTax | Double | False | | No | Shipping price excl tax. | | PriceInclTax | Double | False | | No | Shipping price incl tax. | [Return to Top](#objects-supported) ## Inventory | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------------ | ------ | -------- | ---------- | ---------- | ------------------------------------------------------------------------ | | Items | String | False | | No | Items | | ProductSku [KEY] | String | False | | No | This is an auto generated column. | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | | Backorders | Int | False | | No | Backorders status | | EnableQtyIncrements | Bool | False | | No | Whether Quantity Increments is enabled | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsDecimalDivided | Bool | False | | No | This is an auto-generated column | | IsInStock | Bool | False | | No | Stock Availability | | IsQtyDecimal | Bool | False | | No | This is an auto-generated column | | ItemId [KEY] | Int | False | | No | This is an auto-generated column | | LowStockDate | String | False | | No | This is an auto-generated column | | ManageStock | Bool | False | | No | Can Manage Stock | | MaxSaleQty | Double | False | | No | Maximum Qty Allowed in Shopping Cart data wrapper | | MinQty | Double | False | | No | Minimal quantity available for item status in stock | | MinSaleQty | Double | False | | No | Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation | | NotifyStockQty | Double | False | | No | Notify for Quantity Below data wrapper | | ProductId | Int | False | | No | This is an auto-generated column | | Qty | Double | False | | No | This is an auto-generated column | | QtyIncrements | Double | False | | No | Quantity Increments data wrapper | | ShowDefaultNotificationMessage | Bool | False | | No | This is an auto-generated column | | StockId | Int | False | | No | Stock identifier | | StockStatusChangedAuto | Int | False | | No | This is an auto-generated column | | UseConfigBackorders | Bool | False | | No | This is an auto-generated column | | UseConfigEnableQtyInc | Bool | False | | No | This is an auto-generated column | | UseConfigManageStock | Bool | False | | No | This is an auto-generated column | | UseConfigMaxSaleQty | Bool | False | | No | This is an auto-generated column | | UseConfigMinQty | Bool | False | | No | This is an auto-generated column | | UseConfigMinSaleQty | Int | False | | No | This is an auto-generated column | | UseConfigNotifyStockQty | Bool | False | | No | This is an auto-generated column | | UseConfigQtyIncrements | Bool | False | | No | This is an auto-generated column | | StockItem | String | False | | No | This is an auto-generated column | | StockStatus | Int | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## InventoryApiGetSourcesAssignedToStockOrderedByPriority | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------ | | CarrierLinks | String | False | | No | This is an auto-generated column | | StockId | String | False | | No | stockId | | City | String | False | | No | Source city | | ContactName | String | False | | No | Source contact name | | CountryId | String | False | | No | Source country id | | Description | String | False | | No | Source description | | Email | String | False | | No | Source email | | Enabled | Bool | False | | No | If source is enabled. For new entity can be null | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Fax | String | False | | No | Source fax | | Latitude | Double | False | | No | Source latitude | | Longitude | Double | False | | No | Source longitude | | Name | String | False | | No | Source name | | Phone | String | False | | No | Source phone number | | Postcode | String | False | | No | Source post code | | Region | String | False | | No | Region title if source has custom region | | RegionId | Int | False | | No | Region id if source has registered region. | | SourceCode | String | False | | No | Source code | | Street | String | False | | No | Source street name | | UseDefaultCarrierConfig | Bool | False | | No | Is need to use default config | [Return to Top](#objects-supported) ## InventoryApiGetStockSourceLinks | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Priority | Int | False | | No | Priority of the link | | SearchCriteria | String | False | | No | This is an auto-generated column | | SourceCode | String | False | | No | Source code of the link | | StockId | Int | False | | No | Stock id | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## InventoryApiSource | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------ | | CarrierLinks | String | False | | No | This is an auto-generated column | | City | String | False | | No | Source city | | ContactName | String | False | | No | Source contact name | | CountryId | String | False | | No | Source country id | | Description | String | False | | No | Source description | | Email | String | False | | No | Source email | | Enabled | Bool | False | | No | If source is enabled. For new entity can be null | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Fax | String | False | | No | Source fax | | Latitude | Double | False | | No | Source latitude | | Longitude | Double | False | | No | Source longitude | | Name | String | False | | No | Source name | | Phone | String | False | | No | Source phone number | | Postcode | String | False | | No | Source post code | | Region | String | False | | No | Region title if source has custom region | | RegionId | Int | False | | No | Region id if source has registered region. | | SearchCriteria | String | False | | No | This is an auto-generated column | | SourceCode | String | False | | No | Source code | | Street | String | False | | No | Source street name | | TotalCount | Int | False | | No | Total count. | | UseDefaultCarrierConfig | Bool | False | | No | Is need to use default config | [Return to Top](#objects-supported) ## InventoryApiSourceItem | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Quantity | Double | False | | No | Source item quantity | | SearchCriteria | String | False | | No | This is an auto-generated column | | Sku | String | False | | No | Source item sku | | SourceCode | String | False | | No | Source code | | Status | Int | False | | No | Source item status (One of self::STATUS\_\*) | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## InventoryApiStock | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Name | String | False | | No | Stock name | | SearchCriteria | String | False | | No | This is an auto-generated column | | StockId | Int | False | | No | Stock id | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## OrderComments | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ------------------------------------ | | Comment | String | False | | No | Comment. | | Id | String | False | | No | id | | CreatedAt | Datetime | False | | No | Created-at timestamp. | | EntityId [KEY] | Int | False | | No | Order status history ID. | | EntityName | String | False | | No | Entity name. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsCustomerNotified | Int | False | | No | Is-customer-notified flag value. | | IsVisibleOnFront | Int | False | | No | Is-visible-on-storefront flag value. | | ParentId | Int | False | | No | Parent ID. | | SearchCriteria | String | False | | No | This is an auto-generated column | | Status | String | False | | No | Status. | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## OrderItems | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------------------------------- | -------- | -------- | ---------- | ---------- | ---------------------------------------- | | AdditionalData | String | False | | No | Additional data. | | Id | String | False | | No | id | | AmountRefunded | Double | False | | No | Amount refunded. | | AppliedRuleIds | String | False | | No | Applied rule IDs. | | BaseAmountRefunded | Double | False | | No | Base amount refunded. | | BaseCost | Double | False | | No | Base cost. | | BaseDiscountAmount | Double | False | | No | Base discount amount. | | BaseDiscountInvoiced | Double | False | | No | Base discount invoiced. | | BaseDiscountRefunded | Double | False | | No | Base discount refunded. | | BaseDiscountTaxCompensationAmount | Double | False | | No | Base discount tax compensation amount. | | BaseDiscountTaxCompensationInvoiced | Double | False | | No | Base discount tax compensation invoiced. | | BaseDiscountTaxCompensationRefunded | Double | False | | No | Base discount tax compensation refunded. | | BaseOriginalPrice | Double | False | | No | Base original price. | | BasePrice | Double | False | | No | Base price. | | BasePriceInclTax | Double | False | | No | Base price including tax. | | BaseRowInvoiced | Double | False | | No | Base row invoiced. | | BaseRowTotal | Double | False | | No | Base row total. | | BaseRowTotalInclTax | Double | False | | No | Base row total including tax. | | BaseTaxAmount | Double | False | | No | Base tax amount. | | BaseTaxBeforeDiscount | Double | False | | No | Base tax before discount. | | BaseTaxInvoiced | Double | False | | No | Base tax invoiced. | | BaseTaxRefunded | Double | False | | No | Base tax refunded. | | BaseWeeeTaxAppliedAmount | Double | False | | No | Base WEEE tax applied amount. | | BaseWeeeTaxAppliedRowAmnt | Double | False | | No | Base WEEE tax applied row amount. | | BaseWeeeTaxDisposition | Double | False | | No | Base WEEE tax disposition. | | BaseWeeeTaxRowDisposition | Double | False | | No | Base WEEE tax row disposition. | | CreatedAt | Datetime | False | | No | Created-at timestamp. | | Description | String | False | | No | Description. | | DiscountAmount | Double | False | | No | Discount amount. | | DiscountInvoiced | Double | False | | No | Discount invoiced. | | DiscountPercent | Double | False | | No | Discount percent. | | DiscountRefunded | Double | False | | No | Discount refunded. | | DiscountTaxCompensationAmount | Double | False | | No | Discount tax compensation amount. | | DiscountTaxCompensationCanceled | Double | False | | No | Discount tax compensation canceled. | | DiscountTaxCompensationInvoiced | Double | False | | No | Discount tax compensation invoiced. | | DiscountTaxCompensationRefunded | Double | False | | No | Discount tax compensation refunded. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | ExtOrderItemId | String | False | | No | External order item ID. | | FreeShipping | Int | False | | No | Free-shipping flag value. | | IsQtyDecimal | Int | False | | No | Is-quantity-decimal flag value. | | IsVirtual | Int | False | | No | Is-virtual flag value. | | ItemId [KEY] | Int | False | | No | Item ID. | | LockedDoInvoice | Int | False | | No | Locked DO invoice flag value. | | LockedDoShip | Int | False | | No | Locked DO ship flag value. | | Name | String | False | | No | Name. | | NoDiscount | Int | False | | No | No-discount flag value. | | OrderId | Int | False | | No | Order ID. | | OriginalPrice | Double | False | | No | Original price. | | ParentItem | String | False | | No | This is an auto-generated column | | ParentItemId | Int | False | | No | Parent item ID. | | Price | Double | False | | No | Price. | | PriceInclTax | Double | False | | No | Price including tax. | | ProductId | Int | False | | No | Product ID. | | ProductOption | String | False | | No | This is an auto-generated column | | ProductType | String | False | | No | Product type. | | QtyBackordered | Double | False | | No | Quantity backordered. | | QtyCanceled | Double | False | | No | Quantity canceled. | | QtyInvoiced | Double | False | | No | Quantity invoiced. | | QtyOrdered | Double | False | | No | Quantity ordered. | | QtyRefunded | Double | False | | No | Quantity refunded. | | QtyShipped | Double | False | | No | Quantity shipped. | | QuoteItemId | Int | False | | No | Quote item ID. | | RowInvoiced | Double | False | | No | Row invoiced. | | RowTotal | Double | False | | No | Row total. | | RowTotalInclTax | Double | False | | No | Row total including tax. | | RowWeight | Double | False | | No | Row weight. | | SearchCriteria | String | False | | No | This is an auto-generated column | | Sku | String | False | | No | SKU. | | StoreId | Int | False | | No | Store ID. | | TaxAmount | Double | False | | No | Tax amount. | | TaxBeforeDiscount | Double | False | | No | Tax before discount. | | TaxCanceled | Double | False | | No | Tax canceled. | | TaxInvoiced | Double | False | | No | Tax invoiced. | | TaxPercent | Double | False | | No | Tax percent. | | TaxRefunded | Double | False | | No | Tax refunded. | | TotalCount | Int | False | | No | Total count. | | UpdatedAt | Datetime | False | | No | Updated-at timestamp. | | WeeeTaxApplied | String | False | | No | WEEE tax applied. | | WeeeTaxAppliedAmount | Double | False | | No | WEEE tax applied amount. | | WeeeTaxAppliedRowAmount | Double | False | | No | WEEE tax applied row amount. | | WeeeTaxDisposition | Double | False | | No | WEEE tax disposition. | | WeeeTaxRowDisposition | Double | False | | No | WEEE tax row disposition. | | Weight | Double | False | | No | Weight. | [Return to Top](#objects-supported) ## Orders | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------------------------------- | -------- | -------- | ---------- | ---------- | ----------------------------------------------- | | AdjustmentNegative | Double | False | | No | Negative adjustment value. | | Id | String | False | | No | id | | AdjustmentPositive | Double | False | | No | Positive adjustment value. | | AppliedRuleIds | String | False | | No | Applied rule IDs. | | BaseAdjustmentNegative | Double | False | | No | Base negative adjustment value. | | BaseAdjustmentPositive | Double | False | | No | Base positive adjustment value. | | BaseCurrencyCode | String | False | | No | Base currency code. | | BaseDiscountAmount | Double | False | | No | Base discount amount. | | BaseDiscountCanceled | Double | False | | No | Base discount canceled. | | BaseDiscountInvoiced | Double | False | | No | Base discount invoiced. | | BaseDiscountRefunded | Double | False | | No | Base discount refunded. | | BaseDiscountTaxCompensationAmount | Double | False | | No | Base discount tax compensation amount. | | BaseDiscountTaxCompensationInvoiced | Double | False | | No | Base discount tax compensation invoiced. | | BaseDiscountTaxCompensationRefunded | Double | False | | No | Base discount tax compensation refunded. | | BaseGrandTotal | Double | False | | No | Base grand total. | | BaseShippingAmount | Double | False | | No | Base shipping amount. | | BaseShippingCanceled | Double | False | | No | Base shipping canceled. | | BaseShippingDiscountAmount | Double | False | | No | Base shipping discount amount. | | BaseShippingDiscountTaxCompensationAmnt | Double | False | | No | Base shipping discount tax compensation amount. | | BaseShippingInclTax | Double | False | | No | Base shipping including tax. | | BaseShippingInvoiced | Double | False | | No | Base shipping invoiced. | | BaseShippingRefunded | Double | False | | No | Base shipping refunded. | | BaseShippingTaxAmount | Double | False | | No | Base shipping tax amount. | | BaseShippingTaxRefunded | Double | False | | No | Base shipping tax refunded. | | BaseSubtotal | Double | False | | No | Base subtotal. | | BaseSubtotalCanceled | Double | False | | No | Base subtotal canceled. | | BaseSubtotalInclTax | Double | False | | No | Base subtotal including tax. | | BaseSubtotalInvoiced | Double | False | | No | Base subtotal invoiced. | | BaseSubtotalRefunded | Double | False | | No | Base subtotal refunded. | | BaseTaxAmount | Double | False | | No | Base tax amount. | | BaseTaxCanceled | Double | False | | No | Base tax canceled. | | BaseTaxInvoiced | Double | False | | No | Base tax invoiced. | | BaseTaxRefunded | Double | False | | No | Base tax refunded. | | BaseToGlobalRate | Double | False | | No | Base-to-global rate. | | BaseToOrderRate | Double | False | | No | Base-to-order rate. | | BaseTotalCanceled | Double | False | | No | Base total canceled. | | BaseTotalDue | Double | False | | No | Base total due. | | BaseTotalInvoiced | Double | False | | No | Base total invoiced. | | BaseTotalInvoicedCost | Double | False | | No | Base total invoiced cost. | | BaseTotalOfflineRefunded | Double | False | | No | Base total offline refunded. | | BaseTotalOnlineRefunded | Double | False | | No | Base total online refunded. | | BaseTotalPaid | Double | False | | No | Base total paid. | | BaseTotalQtyOrdered | Double | False | | No | Base total quantity ordered. | | BaseTotalRefunded | Double | False | | No | Base total refunded. | | BillingAddress | String | False | | No | This is an auto-generated column | | BillingAddressId | Int | False | | No | Billing address ID. | | CanShipPartially | Int | False | | No | Can-ship-partially flag value. | | CanShipPartiallyItem | Int | False | | No | Can-ship-partially-item flag value. | | CouponCode | String | False | | No | Coupon code. | | CreatedAt | Datetime | False | | No | Created-at timestamp. | | CustomerDob | String | False | | No | Customer date-of-birth (DOB). | | CustomerEmail | String | False | | No | Customer email address. | | CustomerFirstname | String | False | | No | Customer first name. | | CustomerGender | Int | False | | No | Customer gender. | | CustomerGroupId | Int | False | | No | Customer group ID. | | CustomerId | Int | False | | No | Customer ID. | | CustomerIsGuest | Int | False | | No | Customer-is-guest flag value. | | CustomerLastname | String | False | | No | Customer last name. | | CustomerMiddlename | String | False | | No | Customer middle name. | | CustomerNote | String | False | | No | Customer note. | | CustomerNoteNotify | Int | False | | No | Customer-note-notify flag value. | | CustomerPrefix | String | False | | No | Customer prefix. | | CustomerSuffix | String | False | | No | Customer suffix. | | CustomerTaxvat | String | False | | No | Customer value-added tax (VAT). | | DiscountAmount | Double | False | | No | Discount amount. | | DiscountCanceled | Double | False | | No | Discount canceled. | | DiscountDescription | String | False | | No | Discount description. | | DiscountInvoiced | Double | False | | No | Discount invoiced. | | DiscountRefunded | Double | False | | No | Discount refunded amount. | | DiscountTaxCompensationAmount | Double | False | | No | Discount tax compensation amount. | | DiscountTaxCompensationInvoiced | Double | False | | No | Discount tax compensation invoiced amount. | | DiscountTaxCompensationRefunded | Double | False | | No | Discount tax compensation refunded amount. | | EditIncrement | Int | False | | No | Edit increment value. | | EmailSent | Int | False | | No | Email-sent flag value. | | EntityId [KEY] | Int | False | | No | Order ID. | | ExtCustomerId | String | False | | No | External customer ID. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | ExtOrderId | String | False | | No | External order ID. | | ForcedShipmentWithInvoice | Int | False | | No | Forced-shipment-with-invoice flag value. | | GlobalCurrencyCode | String | False | | No | Global currency code. | | GrandTotal | Double | False | | No | Grand total. | | HoldBeforeState | String | False | | No | Hold before state. | | HoldBeforeStatus | String | False | | No | Hold before status. | | IncrementId | String | False | | No | Increment ID. | | IsVirtual | Int | False | | No | Is-virtual flag value. | | Items | String | False | | No | Array of items. | | OrderCurrencyCode | String | False | | No | Order currency code. | | OriginalIncrementId | String | False | | No | Original increment ID. | | Payment | String | False | | No | This is an auto-generated column | | PaymentAuthExpiration | Int | False | | No | Payment authorization expiration date. | | PaymentAuthorizationAmount | Double | False | | No | Payment authorization amount. | | ProtectCode | String | False | | No | Protect code. | | QuoteAddressId | Int | False | | No | Quote address ID. | | QuoteId | Int | False | | No | Quote ID. | | RelationChildId | String | False | | No | Relation child ID. | | RelationChildRealId | String | False | | No | Relation child real ID. | | RelationParentId | String | False | | No | Relation parent ID. | | RelationParentRealId | String | False | | No | Relation parent real ID. | | RemoteIp | String | False | | No | Remote IP address. | | SearchCriteria | String | False | | No | This is an auto-generated column | | ShippingAmount | Double | False | | No | Shipping amount. | | ShippingCanceled | Double | False | | No | Shipping canceled amount. | | ShippingDescription | String | False | | No | Shipping description. | | ShippingDiscountAmount | Double | False | | No | Shipping discount amount. | | ShippingDiscountTaxCompensationAmount | Double | False | | No | Shipping discount tax compensation amount. | | ShippingInclTax | Double | False | | No | Shipping including tax amount. | | ShippingInvoiced | Double | False | | No | Shipping invoiced amount. | | ShippingRefunded | Double | False | | No | Shipping refunded amount. | | ShippingTaxAmount | Double | False | | No | Shipping tax amount. | | ShippingTaxRefunded | Double | False | | No | Shipping tax refunded amount. | | State | String | False | | No | State. | | Status | String | False | | No | Status. | | StatusHistories | String | False | | No | Array of status histories. | | StoreCurrencyCode | String | False | | No | Store currency code. | | StoreId | Int | False | | No | Store ID. | | StoreName | String | False | | No | Store name. | | StoreToBaseRate | Double | False | | No | Store-to-base rate. | | StoreToOrderRate | Double | False | | No | Store-to-order rate. | | Subtotal | Double | False | | No | Subtotal. | | SubtotalCanceled | Double | False | | No | Subtotal canceled amount. | | SubtotalInclTax | Double | False | | No | Subtotal including tax amount. | | SubtotalInvoiced | Double | False | | No | Subtotal invoiced amount. | | SubtotalRefunded | Double | False | | No | Subtotal refunded amount. | | TaxAmount | Double | False | | No | Tax amount. | | TaxCanceled | Double | False | | No | Tax canceled amount. | | TaxInvoiced | Double | False | | No | Tax invoiced amount. | | TaxRefunded | Double | False | | No | Tax refunded amount. | | TotalCanceled | Double | False | | No | Total canceled. | | TotalCount | Int | False | | No | Total count. | | TotalDue | Double | False | | No | Total due. | | TotalInvoiced | Double | False | | No | Total invoiced amount. | | TotalItemCount | Int | False | | No | Total item count. | | TotalOfflineRefunded | Double | False | | No | Total offline refunded amount. | | TotalOnlineRefunded | Double | False | | No | Total online refunded amount. | | TotalPaid | Double | False | | No | Total paid. | | TotalQtyOrdered | Double | False | | No | Total quantity ordered. | | TotalRefunded | Double | False | | No | Total amount refunded. | | UpdatedAt | Datetime | False | | No | Updated-at timestamp. | | Weight | Double | False | | No | Weight. | | XForwardedFor | String | False | | No | X-Forwarded-For field value. | [Return to Top](#objects-supported) ## PaymentMethods | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------- | ------ | -------- | ---------- | ---------- | -------------------- | | Code [KEY] | String | False | | No | Payment method code | | CartId | String | False | | No | cartId | | Title | String | False | | No | Payment method title | [Return to Top](#objects-supported) ## PaymentSelectedMethods | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | AdditionalData | String | False | | No | Payment additional details | | CartId | String | False | | No | cartId | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Method [KEY] | String | False | | No | Payment method code | | PoNumber | String | False | | No | Purchase order number | [Return to Top](#objects-supported) ## PayPalBraintreeAuth | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ActionSuccess | String | False | | No | To success page | | ClientToken | String | False | | No | Client token | | DisplayName | String | False | | No | Display name | | LoggedIn | Bool | False | | No | This is an auto-generated column | | StoreCode | String | False | | No | Current store code | [Return to Top](#objects-supported) ## ProductAttributeGroup | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | AttributeGroupId [KEY] | String | False | | No | Id | | AttributeGroupName | String | False | | No | Name | | AttributeSetId | Int | False | | No | Attribute set id | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## ProductAttributeOptions | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------- | ------ | -------- | ---------- | ---------- | ----------------------------- | | IsDefault | Bool | False | | No | Default | | AttributeCode | String | False | | No | attributeCode | | Label [KEY] | String | False | | No | Option label | | SortOrder | Int | False | | No | Option order | | StoreLabels | String | False | | No | Option label for store scopes | | Value | String | False | | No | Option value | [Return to Top](#objects-supported) ## ProductAttributes | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------- | ------ | -------- | ---------- | ---------- | -------------------------------------------------------- | | ApplyTo | String | False | | No | Apply to value for the element | | AttributeSetId | String | False | | No | attributeSetId | | AttributeCode | String | False | | No | Code of the attribute. | | AttributeId [KEY] | Int | False | | No | Id of the attribute. | | BackendModel | String | False | | No | Backend model | | BackendType | String | False | | No | Backend type. | | DefaultFrontendLabel | String | False | | No | Frontend label for default store | | DefaultValue | String | False | | No | Default value for the element. | | EntityTypeId | String | False | | No | Entity type id | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | FrontendClass | String | False | | No | Frontend class of attribute | | FrontendInput | String | False | | No | HTML for input element. | | FrontendLabels | String | False | | No | Frontend label for each store | | IsComparable | String | False | | No | The attribute can be compared on the frontend | | IsFilterable | Bool | False | | No | It used in layered navigation | | IsFilterableInGrid | Bool | False | | No | It is filterable in catalog product grid | | IsFilterableInSearch | Bool | False | | No | It is used in search results layered navigation | | IsHtmlAllowedOnFront | Bool | False | | No | The HTML tags are allowed on the frontend | | IsRequired | Bool | False | | No | Attribute is required. | | IsSearchable | String | False | | No | The attribute can be used in Quick Search | | IsUnique | String | False | | No | This is a unique attribute | | IsUsedForPromoRules | String | False | | No | The attribute can be used for promo rules | | IsUsedInGrid | Bool | False | | No | It is used in catalog product grid | | IsUserDefined | Bool | False | | No | Current attribute has been defined by a user. | | IsVisible | Bool | False | | No | Attribute is visible on frontend. | | IsVisibleInAdvancedSearch | String | False | | No | The attribute can be used in Advanced Search | | IsVisibleInGrid | Bool | False | | No | It is visible in catalog product grid | | IsVisibleOnFront | String | False | | No | The attribute is visible on the frontend | | IsWysiwygEnabled | Bool | False | | No | WYSIWYG flag | | Note | String | False | | No | The note attribute for the element. | | Options | String | False | | No | Options of the attribute (key => value pairs for select) | | Position | Int | False | | No | Position | | Scope | String | False | | No | Attribute scope | | SourceModel | String | False | | No | Source model | | UsedForSortBy | Bool | False | | No | It is used for sorting in product listing | | UsedInProductListing | String | False | | No | The attribute can be used in product listing | | ValidationRules | String | False | | No | Validation rules. | [Return to Top](#objects-supported) ## ProductCategories | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | This is an auto-generated column | | CategoryId | String | False | | No | categoryId | | AvailableSortBy | String | False | | No | This is an auto-generated column | | Children | String | False | | No | This is an auto-generated column | | CreatedAt | Datetime | False | | No | This is an auto-generated column | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IncludeInMenu | Bool | False | | No | This is an auto-generated column | | IsActive | Bool | False | | No | Whether category is active | | Level | Int | False | | No | Category level | | Name | String | False | | No | Category name | | ParentId | Int | False | | No | Parent category ID | | Path | String | False | | No | This is an auto-generated column | | Position | Int | False | | No | Category position | | UpdatedAt | Datetime | False | | No | This is an auto-generated column | | ProductCount | Int | False | | No | Product count | [Return to Top](#objects-supported) ## ProductCustomOption | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | FileExtension | String | False | | No | This is an auto-generated column | | ImageSizeX | Int | False | | No | This is an auto-generated column | | ImageSizeY | Int | False | | No | This is an auto-generated column | | IsRequire | Bool | False | | No | Is require | | MaxCharacters | Int | False | | No | This is an auto-generated column | | OptionId [KEY] | Int | False | | No | Option id | | Price | Double | False | | No | Price | | PriceType | String | False | | No | Price type | | ProductSku | String | False | | No | Product SKU | | Sku | String | False | | No | Sku | | SortOrder | Int | False | | No | Sort order | | Title | String | False | | No | Option title | | Type | String | False | | No | Option type | | Values | String | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## ProductMedia | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------------------- | | Id [KEY] | Int | False | | No | Gallery entry ID | | Sku | String | False | | No | sku | | Content | String | False | | No | This is an auto-generated column | | Disabled | Bool | False | | No | If gallery entry is hidden from product page | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | File | String | False | | No | File path | | Label | String | False | | No | Gallery entry alternative text | | MediaType | String | False | | No | Media type | | Position | Int | False | | No | Gallery entry position (sort order) | | Types | String | False | | No | Gallery entry image types (thumbnail, image, small_image etc) | [Return to Top](#objects-supported) ## Products | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------------ | -------- | -------- | ---------- | ---------- | -------------------------------- | | Id | Int | False | | No | Id | | AttributeSetId | Int | False | | No | Attribute set id | | CreatedAt | Datetime | False | | No | Created date | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | MediaGalleryEntries | String | False | | No | Media gallery entries | | Name | String | False | | No | Name | | Options | String | False | | No | List of product options | | Price | Double | False | | No | Price | | ProductLinks | String | False | | No | Product links info | | Sku [KEY] | String | False | | No | Sku | | Status | Int | False | | No | Status | | TierPrices | String | False | | No | List of product tier prices | | TypeId | String | False | | No | Type id | | UpdatedAt | Datetime | False | | No | Updated date | | Visibility | Int | False | | No | Visibility | | Weight | Double | False | | No | Weight | | description | String | False | | No | Custom Attribute field | | short_description | String | False | | No | Custom Attribute field | | special_price | Decimal | False | | No | Custom Attribute field | | special_from_date | Datetime | False | | No | Custom Attribute field | | special_to_date | Datetime | False | | No | Custom Attribute field | | cost | Decimal | False | | No | Custom Attribute field | | manufacturer | Int | False | | No | Custom Attribute field | | meta_title | String | False | | No | Custom Attribute field | | meta_keyword | String | False | | No | Custom Attribute field | | meta_description | String | False | | No | Custom Attribute field | | image | String | False | | No | Custom Attribute field | | small_image | String | False | | No | Custom Attribute field | | thumbnail | String | False | | No | Custom Attribute field | | media_gallery | String | False | | No | Custom Attribute field | | old_id | Int | False | | No | Custom Attribute field | | tier_price | Decimal | False | | No | Custom Attribute field | | color | Int | False | | No | Custom Attribute field | | news_from_date | Datetime | False | | No | Custom Attribute field | | news_to_date | Datetime | False | | No | Custom Attribute field | | gallery | String | False | | No | Custom Attribute field | | minimal_price | Decimal | False | | No | Custom Attribute field | | custom_design | String | False | | No | Custom Attribute field | | custom_design_from | Datetime | False | | No | Custom Attribute field | | custom_design_to | Datetime | False | | No | Custom Attribute field | | custom_layout_update | String | False | | No | Custom Attribute field | | page_layout | String | False | | No | Custom Attribute field | | category_ids | String | False | | No | Custom Attribute field | | options_container | String | False | | No | Custom Attribute field | | required_options | String | False | | No | Custom Attribute field | | has_options | String | False | | No | Custom Attribute field | | image_label | String | False | | No | Custom Attribute field | | small_image_label | String | False | | No | Custom Attribute field | | thumbnail_label | String | False | | No | Custom Attribute field | | created_at | String | False | | No | Custom Attribute field | | updated_at | String | False | | No | Custom Attribute field | | country_of_manufacture | String | False | | No | Custom Attribute field | | quantity_and_stock_status | Int | False | | No | Custom Attribute field | | custom_layout | String | False | | No | Custom Attribute field | | url_key | String | False | | No | Custom Attribute field | | url_path | String | False | | No | Custom Attribute field | | msrp | Decimal | False | | No | Custom Attribute field | | msrp_display_actual_price_type | String | False | | No | Custom Attribute field | | price_type | Int | False | | No | Custom Attribute field | | sku_type | Int | False | | No | Custom Attribute field | | weight_type | Int | False | | No | Custom Attribute field | | price_view | Int | False | | No | Custom Attribute field | | shipment_type | Int | False | | No | Custom Attribute field | | links_purchased_separately | Int | False | | No | Custom Attribute field | | samples_title | String | False | | No | Custom Attribute field | | links_title | String | False | | No | Custom Attribute field | | links_exist | Int | False | | No | Custom Attribute field | | swatch_image | String | False | | No | Custom Attribute field | | tax_class_id | Int | False | | No | Custom Attribute field | | gift_message_available | String | False | | No | Custom Attribute field | | ryanattribute | String | False | | No | Custom Attribute field | | ryan_attribute | String | False | | No | Custom Attribute field | | deti_attr | String | False | | No | Custom Attribute field | | deti_attribut | String | False | | No | Custom Attribute field | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## QuoteCart | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ------------------------------------------------------------------- | | Id [KEY] | Int | False | | No | Cart/quote ID. | | CartId | String | False | | No | cartId | | BillingAddress | String | False | | No | This is an auto-generated column | | ConvertedAt | String | False | | No | Cart conversion date and time. Otherwise, null. | | CreatedAt | Datetime | False | | No | Cart creation date and time. Otherwise, null. | | Currency | String | False | | No | This is an auto-generated column | | Customer | String | False | | No | This is an auto-generated column | | CustomerIsGuest | Bool | False | | No | For guest customers, false for logged in customers | | CustomerNote | String | False | | No | Notice text | | CustomerNoteNotify | Bool | False | | No | Customer notification flag | | CustomerTaxClassId | Int | False | | No | Customer tax class ID. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsActive | Bool | False | | No | Active status flag value. Otherwise, null. | | IsVirtual | Bool | False | | No | Virtual flag value. Otherwise, null. | | Items | String | False | | No | Array of items. Otherwise, null. | | ItemsCount | Int | False | | No | Number of different items or products in the cart. Otherwise, null. | | ItemsQty | Double | False | | No | Total quantity of all cart items. Otherwise, null. | | OrigOrderId | Int | False | | No | Original order ID. Otherwise, null. | | ReservedOrderId | Int | False | | No | Reserved order ID. Otherwise, null. | | SearchCriteria | String | False | | No | This is an auto-generated column | | StoreId | Int | False | | No | Store identifier | | TotalCount | Int | False | | No | Total count. | | UpdatedAt | Datetime | False | | No | Cart last update date and time. Otherwise, null. | [Return to Top](#objects-supported) ## QuoteCartItem | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | CartId | String | False | | No | cartId | | ItemId | Int | False | | No | Item ID. Otherwise, null. | | Name | String | False | | No | Product name. Otherwise, null. | | Price | Double | False | | No | Product price. Otherwise, null. | | ProductOption | String | False | | No | This is an auto-generated column | | ProductType | String | False | | No | Product type. Otherwise, null. | | Qty | Double | False | | No | Product quantity. | | QuoteId [KEY] | String | False | | No | Quote id. | | Sku | String | False | | No | Product SKU. Otherwise, null. | [Return to Top](#objects-supported) ## QuoteCartTotal | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------ | | BaseCurrencyCode | String | False | | No | Base currency code | | CartId | String | False | | No | cartId | | BaseDiscountAmount | Double | False | | No | Discount amount in base currency | | BaseGrandTotal | Double | False | | No | Grand total in base currency | | BaseShippingAmount | Double | False | | No | Shipping amount in base currency | | BaseShippingDiscountAmount | Double | False | | No | Shipping discount amount in base currency | | BaseShippingInclTax | Double | False | | No | Shipping including tax in base currency | | BaseShippingTaxAmount | Double | False | | No | Shipping tax amount in base currency | | BaseSubtotal | Double | False | | No | Subtotal in base currency | | BaseSubtotalInclTax | Double | False | | No | Subtotal including tax in base currency | | BaseSubtotalWithDiscount | Double | False | | No | Subtotal in base currency with applied discount | | BaseTaxAmount | Double | False | | No | Tax amount in base currency | | CouponCode | String | False | | No | Applied coupon code | | DiscountAmount | Double | False | | No | Discount amount in quote currency | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | GrandTotal | Double | False | | No | Grand total in quote currency | | Items | String | False | | No | Totals by items | | ItemsQty | Int | False | | No | Items qty | | QuoteCurrencyCode | String | False | | No | Quote currency code | | ShippingAmount | Double | False | | No | Shipping amount in quote currency | | ShippingDiscountAmount | Double | False | | No | Shipping discount amount in quote currency | | ShippingInclTax | Double | False | | No | Shipping including tax in quote currency | | ShippingTaxAmount | Double | False | | No | Shipping tax amount in quote currency | | Subtotal | Double | False | | No | Subtotal in quote currency | | SubtotalInclTax | Double | False | | No | Subtotal including tax in quote currency | | SubtotalWithDiscount | Double | False | | No | Subtotal in quote currency with applied discount | | TaxAmount | Double | False | | No | Tax amount in quote currency | | TotalSegments | String | False | | No | Dynamically calculated totals | | WeeeTaxAppliedAmount | Double | False | | No | Item weee tax applied amount in quote currency. | [Return to Top](#objects-supported) ## QuoteGuestCart | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ------------------------------------------------------------------- | | Id [KEY] | Int | False | | No | Cart/quote ID. | | CartId | String | False | | No | cartId | | BillingAddress | String | False | | No | This is an auto-generated column | | ConvertedAt | String | False | | No | Cart conversion date and time. Otherwise, null. | | CreatedAt | Datetime | False | | No | Cart creation date and time. Otherwise, null. | | Currency | String | False | | No | This is an auto-generated column | | Customer | String | False | | No | This is an auto-generated column | | CustomerIsGuest | Bool | False | | No | For guest customers, false for logged in customers | | CustomerNote | String | False | | No | Notice text | | CustomerNoteNotify | Bool | False | | No | Customer notification flag | | CustomerTaxClassId | Int | False | | No | Customer tax class ID. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsActive | Bool | False | | No | Active status flag value. Otherwise, null. | | IsVirtual | Bool | False | | No | Virtual flag value. Otherwise, null. | | Items | String | False | | No | Array of items. Otherwise, null. | | ItemsCount | Int | False | | No | Number of different items or products in the cart. Otherwise, null. | | ItemsQty | Double | False | | No | Total quantity of all cart items. Otherwise, null. | | OrigOrderId | Int | False | | No | Original order ID. Otherwise, null. | | ReservedOrderId | Int | False | | No | Reserved order ID. Otherwise, null. | | StoreId | Int | False | | No | Store identifier | | UpdatedAt | Datetime | False | | No | Cart last update date and time. Otherwise, null. | [Return to Top](#objects-supported) ## QuoteGuestCartItem | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | CartId | String | False | | No | cartId | | ItemId | Int | False | | No | Item ID. Otherwise, null. | | Name | String | False | | No | Product name. Otherwise, null. | | Price | Double | False | | No | Product price. Otherwise, null. | | ProductOption | String | False | | No | This is an auto-generated column | | ProductType | String | False | | No | Product type. Otherwise, null. | | Qty | Double | False | | No | Product quantity. | | QuoteId [KEY] | String | False | | No | Quote id. | | Sku | String | False | | No | Product SKU. Otherwise, null. | [Return to Top](#objects-supported) ## QuoteGuestCartTotal | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------ | | BaseCurrencyCode | String | False | | No | Base currency code | | CartId | String | False | | No | cartId | | BaseDiscountAmount | Double | False | | No | Discount amount in base currency | | BaseGrandTotal | Double | False | | No | Grand total in base currency | | BaseShippingAmount | Double | False | | No | Shipping amount in base currency | | BaseShippingDiscountAmount | Double | False | | No | Shipping discount amount in base currency | | BaseShippingInclTax | Double | False | | No | Shipping including tax in base currency | | BaseShippingTaxAmount | Double | False | | No | Shipping tax amount in base currency | | BaseSubtotal | Double | False | | No | Subtotal in base currency | | BaseSubtotalInclTax | Double | False | | No | Subtotal including tax in base currency | | BaseSubtotalWithDiscount | Double | False | | No | Subtotal in base currency with applied discount | | BaseTaxAmount | Double | False | | No | Tax amount in base currency | | CouponCode | String | False | | No | Applied coupon code | | DiscountAmount | Double | False | | No | Discount amount in quote currency | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | GrandTotal | Double | False | | No | Grand total in quote currency | | Items | String | False | | No | Totals by items | | ItemsQty | Int | False | | No | Items qty | | QuoteCurrencyCode | String | False | | No | Quote currency code | | ShippingAmount | Double | False | | No | Shipping amount in quote currency | | ShippingDiscountAmount | Double | False | | No | Shipping discount amount in quote currency | | ShippingInclTax | Double | False | | No | Shipping including tax in quote currency | | ShippingTaxAmount | Double | False | | No | Shipping tax amount in quote currency | | Subtotal | Double | False | | No | Subtotal in quote currency | | SubtotalInclTax | Double | False | | No | Subtotal including tax in quote currency | | SubtotalWithDiscount | Double | False | | No | Subtotal in quote currency with applied discount | | TaxAmount | Double | False | | No | Tax amount in quote currency | | TotalSegments | String | False | | No | Dynamically calculated totals | | WeeeTaxAppliedAmount | Double | False | | No | Item weee tax applied amount in quote currency. | [Return to Top](#objects-supported) ## SalesCreditmemo | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------------------------------- | -------- | -------- | ---------- | ---------- | ----------------------------------------------------------- | | Adjustment | Double | False | | No | Credit memo adjustment. | | Id | String | False | | No | id | | AdjustmentNegative | Double | False | | No | Credit memo negative adjustment. | | AdjustmentPositive | Double | False | | No | Credit memo positive adjustment. | | BaseAdjustment | Double | False | | No | Credit memo base adjustment. | | BaseAdjustmentNegative | Double | False | | No | Credit memo negative base adjustment. | | BaseAdjustmentPositive | Double | False | | No | Credit memo positive base adjustment. | | BaseCurrencyCode | String | False | | No | Credit memo base currency code. | | BaseDiscountAmount | Double | False | | No | Credit memo base discount amount. | | BaseDiscountTaxCompensationAmount | Double | False | | No | Credit memo base discount tax compensation amount. | | BaseGrandTotal | Double | False | | No | Credit memo base grand total. | | BaseShippingAmount | Double | False | | No | Credit memo base shipping amount. | | BaseShippingDiscountTaxCompensationAmnt | Double | False | | No | Credit memo base shipping discount tax compensation amount. | | BaseShippingInclTax | Double | False | | No | Credit memo base shipping including tax. | | BaseShippingTaxAmount | Double | False | | No | Credit memo base shipping tax amount. | | BaseSubtotal | Double | False | | No | Credit memo base subtotal. | | BaseSubtotalInclTax | Double | False | | No | Credit memo base subtotal including tax. | | BaseTaxAmount | Double | False | | No | Credit memo base tax amount. | | BaseToGlobalRate | Double | False | | No | Credit memo base-to-global rate. | | BaseToOrderRate | Double | False | | No | Credit memo base-to-order rate. | | BillingAddressId | Int | False | | No | Credit memo billing address ID. | | Comments | String | False | | No | Array of any credit memo comments. Otherwise, null. | | CreatedAt | Datetime | False | | No | Credit memo created-at timestamp. | | CreditmemoStatus | Int | False | | No | Credit memo status. | | DiscountAmount | Double | False | | No | Credit memo discount amount. | | DiscountDescription | String | False | | No | Credit memo discount description. | | DiscountTaxCompensationAmount | Double | False | | No | Credit memo discount tax compensation amount. | | EmailSent | Int | False | | No | Credit memo email sent flag value. | | EntityId [KEY] | Int | False | | No | Credit memo ID. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | GlobalCurrencyCode | String | False | | No | Credit memo global currency code. | | GrandTotal | Double | False | | No | Credit memo grand total. | | IncrementId | String | False | | No | Credit memo increment ID. | | InvoiceId | Int | False | | No | Credit memo invoice ID. | | Items | String | False | | No | Array of credit memo items. | | OrderCurrencyCode | String | False | | No | Credit memo order currency code. | | OrderId | Int | False | | No | Credit memo order ID. | | ShippingAddressId | Int | False | | No | Credit memo shipping address ID. | | ShippingAmount | Double | False | | No | Credit memo shipping amount. | | ShippingDiscountTaxCompensationAmount | Double | False | | No | Credit memo shipping discount tax compensation amount. | | ShippingInclTax | Double | False | | No | Credit memo shipping including tax. | | ShippingTaxAmount | Double | False | | No | Credit memo shipping tax amount. | | State | Int | False | | No | Credit memo state. | | StoreCurrencyCode | String | False | | No | Credit memo store currency code. | | StoreId | Int | False | | No | Credit memo store ID. | | StoreToBaseRate | Double | False | | No | Credit memo store-to-base rate. | | StoreToOrderRate | Double | False | | No | Credit memo store-to-order rate. | | Subtotal | Double | False | | No | Credit memo subtotal. | | SubtotalInclTax | Double | False | | No | Credit memo subtotal including tax. | | TaxAmount | Double | False | | No | Credit memo tax amount. | | TransactionId | String | False | | No | Credit memo transaction ID. | | UpdatedAt | Datetime | False | | No | Credit memo updated-at timestamp. | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## SalesCreditmemoComments | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ------------------------------------ | | Comment | String | False | | No | Comment. | | Id | String | False | | No | id | | CreatedAt | Datetime | False | | No | Created-at timestamp. | | EntityId [KEY] | Int | False | | No | Credit memo ID. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsCustomerNotified | Int | False | | No | Is-customer-notified flag value. | | IsVisibleOnFront | Int | False | | No | Is-visible-on-storefront flag value. | | ParentId | Int | False | | No | Parent ID. | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## SalesInvoice | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------------------------------- | -------- | -------- | ---------- | ---------- | ----------------------------------------------- | | BaseCurrencyCode | String | False | | No | Base currency code. | | Id | String | False | | No | id | | BaseDiscountAmount | Double | False | | No | Base discount amount. | | BaseDiscountTaxCompensationAmount | Double | False | | No | Base discount tax compensation amount. | | BaseGrandTotal | Double | False | | No | Base grand total. | | BaseShippingAmount | Double | False | | No | Base shipping amount. | | BaseShippingDiscountTaxCompensationAmnt | Double | False | | No | Base shipping discount tax compensation amount. | | BaseShippingInclTax | Double | False | | No | Base shipping including tax. | | BaseShippingTaxAmount | Double | False | | No | Base shipping tax amount. | | BaseSubtotal | Double | False | | No | Base subtotal. | | BaseSubtotalInclTax | Double | False | | No | Base subtotal including tax. | | BaseTaxAmount | Double | False | | No | Base tax amount. | | BaseToGlobalRate | Double | False | | No | Base-to-global rate. | | BaseToOrderRate | Double | False | | No | Base-to-order rate. | | BaseTotalRefunded | Double | False | | No | Base total refunded. | | BillingAddressId | Int | False | | No | Billing address ID. | | CanVoidFlag | Int | False | | No | Can void flag value. | | Comments | String | False | | No | Array of any invoice comments. Otherwise, null. | | CreatedAt | Datetime | False | | No | Created-at timestamp. | | DiscountAmount | Double | False | | No | Discount amount. | | DiscountDescription | String | False | | No | Discount description. | | DiscountTaxCompensationAmount | Double | False | | No | Discount tax compensation amount. | | EmailSent | Int | False | | No | Email-sent flag value. | | EntityId [KEY] | Int | False | | No | Invoice ID. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | GlobalCurrencyCode | String | False | | No | Global currency code. | | GrandTotal | Double | False | | No | Grand total. | | IncrementId | String | False | | No | Increment ID. | | IsUsedForRefund | Int | False | | No | Is-used-for-refund flag value. | | Items | String | False | | No | Array of invoice items. | | OrderCurrencyCode | String | False | | No | Order currency code. | | OrderId | Int | False | | No | Order ID. | | SearchCriteria | String | False | | No | This is an auto-generated column | | ShippingAddressId | Int | False | | No | Shipping address ID. | | ShippingAmount | Double | False | | No | Shipping amount. | | ShippingDiscountTaxCompensationAmount | Double | False | | No | Shipping discount tax compensation amount. | | ShippingInclTax | Double | False | | No | Shipping including tax. | | ShippingTaxAmount | Double | False | | No | Shipping tax amount. | | State | Int | False | | No | State. | | StoreCurrencyCode | String | False | | No | Store currency code. | | StoreId | Int | False | | No | Store ID. | | StoreToBaseRate | Double | False | | No | Store-to-base rate. | | StoreToOrderRate | Double | False | | No | Store-to-order rate. | | Subtotal | Double | False | | No | Subtotal. | | SubtotalInclTax | Double | False | | No | Subtotal including tax. | | TaxAmount | Double | False | | No | Tax amount. | | TotalCount | Int | False | | No | Total count. | | TotalQty | Double | False | | No | Total quantity. | | TransactionId | String | False | | No | Transaction ID. | | UpdatedAt | Datetime | False | | No | Updated-at timestamp. | [Return to Top](#objects-supported) ## SalesInvoiceComments | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ------------------------------------ | | Comment | String | False | | No | Comment. | | Id | String | False | | No | id | | CreatedAt | Datetime | False | | No | Created-at timestamp. | | EntityId [KEY] | Int | False | | No | Invoice ID. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsCustomerNotified | Int | False | | No | Is-customer-notified flag value. | | IsVisibleOnFront | Int | False | | No | Is-visible-on-storefront flag value. | | ParentId | Int | False | | No | Parent ID. | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## SalesRule | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | ----------------------------------------------- | | ActionCondition | String | False | | No | This is an auto-generated column | | ApplyToShipping | Bool | False | | No | The rule applies to shipping | | Condition | String | False | | No | This is an auto-generated column | | CouponType | String | False | | No | Coupon type | | CustomerGroupIds | String | False | | No | Ids of customer groups that the rule applies to | | Description | String | False | | No | Description | | DiscountAmount | Double | False | | No | Discount amount | | DiscountQty | Double | False | | No | Maximum qty discount is applied | | DiscountStep | Int | False | | No | Discount step | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | FromDate | String | False | | No | The start date when the coupon is active | | IsActive | Bool | False | | No | The coupon is active | | IsAdvanced | Bool | False | | No | Is this field needed | | IsRss | Bool | False | | No | Whether the rule is in RSS | | Name | String | False | | No | Rule name | | ProductIds | String | False | | No | Product ids | | RuleId [KEY] | Int | False | | No | Rule id | | SimpleAction | String | False | | No | Simple action of the rule | | SimpleFreeShipping | String | False | | No | To grant free shipping | | SortOrder | Int | False | | No | Sort order | | StopRulesProcessing | Bool | False | | No | To stop rule processing | | StoreLabels | String | False | | No | Display label | | TimesUsed | Int | False | | No | How many times the rule has been used | | ToDate | String | False | | No | The end date when the coupon is active | | UseAutoGeneration | Bool | False | | No | To auto generate coupon | | UsesPerCoupon | Int | False | | No | Limit of uses per coupon | | UsesPerCustomer | Int | False | | No | Number of uses per customer | | WebsiteIds | String | False | | No | A list of websites the rule applies to | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## SalesRuleCoupon | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ------------------------------------------------------------------- | | Code | String | False | | No | Coupon code | | CouponId [KEY] | Int | False | | No | Coupon id | | CreatedAt | Datetime | False | | No | When the coupon is created | | ExpirationDate | String | False | | No | Expiration date | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsPrimary | Bool | False | | No | The coupon is primary coupon for the rule that it's associated with | | RuleId | Int | False | | No | The id of the rule associated with the coupon | | TimesUsed | Int | False | | No | The number of times the coupon has been used | | Type | Int | False | | No | Of coupon | | UsageLimit | Int | False | | No | Usage limit | | UsagePerCustomer | Int | False | | No | Usage limit per customer | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## SalesShipment | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ------------------------------------------- | | BillingAddressId | Int | False | | No | Billing address ID. | | Id | String | False | | No | id | | Comments | String | False | | No | Array of comments. | | CreatedAt | Datetime | False | | No | Created-at timestamp. | | CustomerId | Int | False | | No | Customer ID. | | EmailSent | Int | False | | No | Email-sent flag value. | | EntityId [KEY] | Int | False | | No | Shipment ID. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IncrementId | String | False | | No | Increment ID. | | Items | String | False | | No | Array of items. | | OrderId | Int | False | | No | Order ID. | | Packages | String | False | | No | Array of packages, if any. Otherwise, null. | | ShipmentStatus | Int | False | | No | Shipment status. | | ShippingAddressId | Int | False | | No | Shipping address ID. | | ShippingLabel | String | False | | No | Shipping label. | | StoreId | Int | False | | No | Store ID. | | TotalQty | Double | False | | No | Total quantity. | | TotalWeight | Double | False | | No | Total weight. | | Tracks | String | False | | No | Array of tracks. | | UpdatedAt | Datetime | False | | No | Updated-at timestamp. | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## SalesShipmentComments | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------- | ---------- | ------------------------------------ | | Comment | String | False | | No | Comment. | | Id | String | False | | No | id | | CreatedAt | Datetime | False | | No | Created-at timestamp. | | EntityId [KEY] | Int | False | | No | Invoice ID. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsCustomerNotified | Int | False | | No | Is-customer-notified flag value. | | IsVisibleOnFront | Int | False | | No | Is-visible-on-storefront flag value. | | ParentId | Int | False | | No | Parent ID. | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## SalesTransaction | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------------- | -------- | -------- | ---------- | ---------- | --------------------------------------------------- | | AdditionalInformation | String | False | | No | Array of additional information. Otherwise, null. | | Id | String | False | | No | id | | ChildTransactions | String | False | | No | Array of child transactions. | | CreatedAt | Datetime | False | | No | Created-at timestamp. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | IsClosed | Int | False | | No | Is-closed flag value. | | OrderId | Int | False | | No | Order ID. | | ParentId | Int | False | | No | The parent ID for the transaction. Otherwise, null. | | ParentTxnId | String | False | | No | Parent transaction business ID. | | PaymentId | Int | False | | No | Payment ID. | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | | TransactionId [KEY] | Int | False | | No | Transaction ID. | | TxnId | String | False | | No | Transaction business ID. | | TxnType | String | False | | No | Transaction type. | [Return to Top](#objects-supported) ## ShippingMethods | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | ------------------------------------------------------------------- | | Amount | Double | False | | No | Shipping amount in store currency. | | CartId | String | False | | No | cartId | | Available | Bool | False | | No | The value of the availability flag for the current shipping method. | | BaseAmount | Double | False | | No | Shipping amount in base currency. | | CarrierCode | String | False | | No | Shipping carrier code. | | CarrierTitle | String | False | | No | Shipping carrier title. Otherwise, null. | | ErrorMessage | String | False | | No | Shipping Error message. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | MethodCode [KEY] | String | False | | No | Shipping method code. | | MethodTitle | String | False | | No | Shipping method title. Otherwise, null. | | PriceExclTax | Double | False | | No | Shipping price excl tax. | | PriceInclTax | Double | False | | No | Shipping price incl tax. | [Return to Top](#objects-supported) ## StoreGroup | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | This is an auto-generated column | | DefaultStoreId | Int | False | | No | This is an auto-generated column | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Name | String | False | | No | This is an auto-generated column | | RootCategoryId | Int | False | | No | This is an auto-generated column | | WebsiteId | Int | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## Stores | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | This is an auto-generated column | | Code | String | False | | No | This is an auto-generated column | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Name | String | False | | No | Store name | | StoreGroupId | Int | False | | No | This is an auto-generated column | | WebsiteId | Int | False | | No | This is an auto-generated column | [Return to Top](#objects-supported) ## StoreWebsite | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | This is an auto-generated column | | Code | String | False | | No | This is an auto-generated column | | DefaultGroupId | Int | False | | No | This is an auto-generated column | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Name | String | False | | No | Website name | [Return to Top](#objects-supported) ## TaxClass | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | ClassId [KEY] | Int | False | | No | Tax class ID. | | TaxClassId | String | False | | No | taxClassId | | ClassName | String | False | | No | Tax class name. | | ClassType | String | False | | No | Tax class type. | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## TaxRate | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Id | | Code | String | False | | No | Tax rate code | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Rate | Double | False | | No | Tax rate in percentage | | RegionName | String | False | | No | Region name | | TaxCountryId | String | False | | No | Country id | | TaxPostcode | String | False | | No | Postcode | | TaxRegionId | Int | False | | No | Region id | | Titles | String | False | | No | Tax rate titles | | ZipFrom | Int | False | | No | Zip range from | | ZipIsRange | Int | False | | No | Zip is range | | ZipTo | Int | False | | No | Zip range to | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported) ## TaxRule | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | ------ | -------- | ---------- | ---------- | -------------------------------- | | Id [KEY] | Int | False | | No | Id | | CalculateSubtotal | Bool | False | | No | Calculate subtotal. | | Code | String | False | | No | Tax rule code | | CustomerTaxClassIds | String | False | | No | Customer tax class id | | ExtensionAttributes | String | False | | No | This is an auto-generated column | | Position | Int | False | | No | Sort order. | | Priority | Int | False | | No | Priority | | ProductTaxClassIds | String | False | | No | Product tax class id | | TaxRateIds | String | False | | No | Tax rate ids | | SearchCriteria | String | False | | No | This is an auto-generated column | | TotalCount | Int | False | | No | Total count. | [Return to Top](#objects-supported)