Commerce

8.4.x

Exports

Endpoint Details

The export endpoint allows data to be retrieved in Import/Export XML format:

GET integration/api/importexport/export

You can only specify one data type for each request. The returned data can be filtered by specifying a Search Query Language query.

Query parameters

The following query parameters are supported:

ParameterRequired or OptionalDescription
typeRequiredThe type of data to export. For more information, see Supported Data Types.
parentTypeOptionalThe parent data type. Certain data types cannot be exported unless a parent data type is specified.
queryOptionalThe Search Query Language query to use to filter the results. For more information about Search Query Language, see Query Format.

Sample request

GET integration/api/importexport/export?type=ProductCategoryAssociation&parentType=Product&query=FIND Product WHERE ProductCode='Dig_Non-Discountable'

Supported Data Types

The headings below represent the data types that can be specified in the type or parentType query parameters of the export endpoint.

Catalog

  • XML data format: Catalogs
  • Search Query Language query syntax: FIND Catalog
  • Search Query Language query fields:
FieldField ParametersSample Query
CatalogCodeN/AFIND Catalog WHERE CatalogCode = 'mobile'

ModifierGroup

  • XML data format: Modifier Groups
  • Search Query Language query syntax: Not applicable

ModifierGroupFilter

Category

  • XML data format: Categories
  • Search Query Language query syntax: FIND Category
  • Search Query Language query fields:
FieldField ParametersSample Query
CategoryCodeN/AFIND Category WHERE CategoryCode = 'MobileGames'
CategoryNameLocale codeFIND Category WHERE CategoryName[en] = 'Mobile Games'
CatalogCodeN/AFIND Category WHERE CatalogCode = 'mobile'

Product

  • XML data format: Products
  • Search Query Language query syntax: FIND Product
  • Search Query Language query fields:
FieldField ParametersSample Query
ProductCodeN/AFIND Product WHERE ProductCode = 'tt0034583'
ProductNameLocale codeFIND Product WHERE ProductName[en] = 'Samsung Galaxy Q'
SkuCodeN/AFIND Product WHERE SkuCode = 'tt0114369_hdb'
ProductStartDateN/AFIND Product WHERE ProductStartDate < '2012-01-01T00:00:00-08:00'
ProductEndDateN/AFIND Product WHERE ProductEndDate > '2018-01-01T00:00:00-08:00'
LastModifiedDateN/AFIND Product WHERE LastModifiedDate > '2020-01-01T00:00:00-08:00'
ProductActiveN/AFIND Product WHERE ProductActive = false
BrandCodeN/AFIND Product WHERE BrandCode = 'Jawbone'
BrandNameLocale codeFIND Product WHERE BrandName[en_US] = 'Jawbone'
StoreCodeN/AFIND Product WHERE StoreCode = 'mobee'
CategoryCodeN/AFIND Product WHERE CategoryCode = 'MobileGames'
CategoryNameLocale codeFIND Product WHERE CategoryName[en] = 'Mobile Games'
AttributeNameAttribute keyFIND Product WHERE AttributeName{rating} = '4'
SkuAttributeNameAttribute keyFIND Product WHERE SkuAttributeName{format} = 'widescreen'

ProductBundle

  • XML data format: Product Bundles
  • Required parent type: Product
  • Search Query Language query syntax: FIND Product
  • Search Query Language query fields: See the Product data type.

ProductCategoryAssociation

  • XML data format: Product Category Associations
  • Required parent type: Product
  • Search Query Language query syntax: FIND Product
  • Search Query Language query fields: See the Product data type.

ProductAssociation

  • XML data format: Product Associations
  • Search Query Language query syntax: FIND ProductAssociation
  • Search Query Language query fields:
FieldField ParametersSample Query
SourceProductCodeN/AFIND Product WHERE SourceProductCode = 'multipleAssociationsSourceProduct'
TargetProductCodeN/AFIND Product WHERE TargetProductCode = 'associatedProductOne'
AssociationTypeN/AFIND Product WHERE AssociationType = CROSS_SELL
CatalogCodeN/AFIND Product WHERE CatalogCode = 'MobileCatalog

AttributePolicy

Inventory

  • XML data format: Inventory
  • Required parent type: Product
  • Search Query Language query syntax: FIND Product
  • Search Query Language query fields: See the Product data type.

PriceListAssignment

  • XML data format: Price List Assignments
  • Search Query Language query syntax: FIND PriceListAssignment
  • Search Query Language query fields:
FieldField ParametersSample Query
CatalogCodeN/AFIND PriceListAssignment WHERE CatalogCode = 'mobile'

PriceListDescriptor

  • XML data format: Price Lists
  • Search Query Language query syntax: FIND PriceList
  • Search Query Language query fields:
FieldField ParametersSample Query
PriceListNameN/AFIND PriceList WHERE PriceListName = 'Mobee Scope Price List'

BaseAmount

  • XML data format: Base Amounts
  • Required parent type: PriceListDescriptor
  • Search Query Language query syntax: FIND PriceList
  • Search Query Language query fields: See the PriceListDescriptor data type.

Promotion

  • XML data format: Promotions
  • Search Query Language query syntax: FIND Promotion
  • Search Query Language query fields:
FieldField ParametersSample Query
CatalogCodeN/AFIND Promotion WHERE CatalogCode = 'mobile'
StoreCodeN/AFIND Promotion WHERE StoreCode = 'mobee'
PromotionTypeN/AFIND Promotion WHERE PromotionType = 'Catalog'
PromotionNameN/AFIND Promotion WHERE PromotionName='10 Dollars Off'

ConditionRule

  • XML data format: Condition Rules
  • Required parent type: Promotion
  • Search Query Language query syntax: FIND Promotion
  • Search Query Language query fields: See the Promotion data type.

CouponSet

  • XML data format: Coupon Set
  • Required parent type: Promotion
  • Search Query Language query syntax: FIND Promotion
  • Search Query Language query fields: See the Promotion data type.

SavedCondition

  • XML data format: Saved Conditions
  • Search Query Language query syntax: Not applicable

Store

  • XML data format: Stores
  • Search Query Language query syntax: FIND Store
  • Search Query Language query fields:
FieldField ParametersSample Query
StoreCodeN/AFIND Store WHERE StoreCode = 'mobee'

StoreAssociation

  • XML data format: Store Associations
  • Required parent type: Store
  • Search Query Language query syntax: FIND Store
  • Search Query Language query fields: See the Store data type.

StoreCustomerAttribute

Warehouse

  • XML data format: Warehouses
  • Search Query Language query syntax: Not applicable

SystemConfiguration

  • XML data format: System Configuration
  • Search Query Language query syntax: FIND Configuration
  • Search Query Language query fields:
FieldField ParametersSample Query
NamespaceN/AFIND Configuration WHERE Namespace = 'COMMERCE/SYSTEM/ASSETS/assetLocation'
ContextN/AFIND Configuration WHERE Namespace = 'COMMERCE/STORE/listPagination' AND Context='MOBEE'

CmUser

  • XML data format: CM Users
  • Search Query Language query syntax: Not applicable

UserRole

  • XML data format: User Roles
  • Search Query Language query syntax: Not applicable

CmImportJob

  • XML data format: CM Import Jobs
  • Search Query Language query syntax: Not applicable

TagGroup

  • XML data format: CM Import Jobs
  • Search Query Language query syntax: Not applicable

TaxJurisdiction

  • XML data format: Tax Jurisdictions
  • Search Query Language query syntax: FIND TaxJurisdiction
  • Search Query Language query fields:
FieldField ParametersSample Query
TaxJurisdictionCodeN/AFIND TaxJurisdiction WHERE TaxJurisdictionCode = 'CATaxJurisdiction'
TaxJurisdictionRegionN/A"FIND TaxJurisdiction WHERE TaxJurisdictionRegion = 'US'

TaxCode

  • XML data format: Tax Codes
  • Search Query Language query syntax: Not applicable

PaymentProvider

  • XML data format: Payment Providers
  • Search Query Language query syntax: Not applicable

Facet

  • XML data format: Facets
  • Search Query Language query syntax: Not applicable

SortAttribute

  • XML data format: Sort Attributes
  • Search Query Language query syntax: Not applicable

ShippingRegion

  • XML data format: Shipping Regions
  • Search Query Language query syntax: Not applicable

ShippingServiceLevel

Customer

  • XML data format: Customers
  • Search Query Language query syntax: FIND Customer
  • Search Query Language query fields:
FieldField ParametersSample Query
SharedIDN/AFIND Customer WHERE SharedID = 'e27ffe24-1281-4841-bc78-d9006ae7771d'
CustomerTypeN/AFIND Customer WHERE CustomerType = ACCOUNT
LastModifiedDateN/AFIND Customer WHERE LastModifiedDate > '2020-01-01T00:00:00-08:00'

CustomerGroup

  • XML data format: Customer Groups
  • Search Query Language query syntax: Not applicable

CustomerConsent

  • XML data format: Customer Consent
  • Required parent type: Customer
  • Search Query Language query syntax: Not applicable

DataPolicy

  • XML data format: Data Policies
  • Search Query Language query syntax: Not applicable

CustomerProfileAttribute

UserAccountAssociation

GiftCertificate

  • XML data format: Gift Certificates
  • Search Query Language query syntax: Not applicable
Last updated on 9/24/2024
← OverviewImports →