Skip to main content
Version: 8.7.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: Catalog Fields

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: Category Fields

Product​

  • XML data format: Products
  • Search Query Language query syntax: FIND Product
  • Search Query Language query fields: Product Fields

ProductBundle​

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

ProductCategoryAssociation​

ProductAssociation​

AttributePolicy​

Inventory​

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

PriceListAssignment​

PriceListDescriptor​

BaseAmount​

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

Promotion​

  • XML data format: Promotions
  • Search Query Language query syntax: FIND Promotion
  • Search Query Language query fields: Promotion Fields

ConditionRule (Deprecated)​

These are now included in the Promotion document type.

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

CouponSet​

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

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: Store Fields

StoreAssociation​

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

StoreCustomerAttribute​

Warehouse​

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

SystemConfiguration​

CmUser​

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​

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: Customer Fields

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

Order​

  • XML data format: Orders
  • Search Query Language query syntax: FIND Order
  • Search Query Language query fields: Order fields
Last updated on