JSON

type description
Address Information about a geographical address.
AddressWithGeolocation Information about a geographical location, including absolute coordinates of the location. This is often used where distance calculations is necessary.
AddressWithName Information about a geographical location, including the name of the resident/tenant. This object is used often as delivery addresses, where you also want to store the name of the delivery recipient.
AggregationWithSize
Aggregations
Aggregations
ApplicationError Represents an application error object that contains information about a specific error thrown by the system.
ApplicationErrors Defines a list of errors.
ArticleCategoryRequest Definition of an article category request
ArticleDetailRequest Article detail request
ArticleDetailRequestParams Article detail request
ArticleListRequest
ArticleListRequestParams Article list request
ArticleSitemapParams Article sitemap request
ArticleSitemapRequest
ArticleSitemapRequest
Attachment Holds data related to an attachment.
Attribute1
Attribute1
Attribute1Bucket
Attribute1BucketItem
Attribute2
Attribute2
Attribute2Bucket
Attribute2BucketItem
Attribute3
Attribute3
Attribute3Bucket
Attribute3BucketItem
Brand
Brand
BrandBucket
BrandBucketItem
BrandCategory
BrandMedia
CancelPurchaseParams Contains information required to cancel an ongoing purchase.
CancelPurchaseResult Contains information about a cancelled purchase.
Category
Category
CategoryBucket
CategoryBucketItem
CategorySitemapParams Article sitemap request
CheckoutDeliveryMethod Defines a delivery method that is available on checkout pages. The method is returned together with a state that says whether or not this method is currently available for the current shopcart.
CheckoutDetails Contains details about that is useful on a checkout page.
CheckoutDetailsRequest Defines a request to get details that can be used on a checkout page.
CheckoutPaymentMethod Defines a payment method that is available on checkout pages. The method is returned together with a state that says whether or not this method is currently available for the current shopcart.
City Represents city matched to connected zip codes.
Connection
ContentCategory Domain of a content category. Holding information about a category's content.
ContentTree Domain representing a content tree node
Country A country defines a market where products are sold.

A country has a single currency, meaning you can't use any other currency when placing orders for that country. For example, if you are ordering goods in the Swedish market, you must pay with SEK.

A country has a default language, however any language can in theory be used for any country when browsing goods, as long as there are translations for that specific language. Languages and countries are in other words not really connected in any important way.

CreatePurchaseParams Defines parameters that are used to create new purchases.
CreatePurchaseParamsSettings Contains settings for creating purchases.
CreatePurchaseResult Defines the result of creating a purchase.
CustomField Class that represents custom fields on purchases
CustomerMessage Holds data related to customer message.
DayOfWeek A day-of-week, such as 'Tuesday'.

Represents the 7 days of the week - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

DeliveryMethod Defines a delivery method that can be used to deliver goods to the consumers.
DeliveryPoint A delivery point is a physical location where shipped goods can be picked up. These can be of arbitrary type, for example physical stores or post offices. These delivery points are bound to a logistics provider. For example, 'Posten' have different delivery points than 'In-store pickup'.
DeliveryPointRule Controls the rules for delivery points of a delivery method.
Dimensions
Entry
Filter
HelloRetailData
HelpdeskTag Holds the category id of the ticket category that represents the different "labels/tags" we can set on helpdesk tickets.
Language Defines the languages that can be used in ETM.

The values of languages are from the ISO 639-1 standard.

LanguageAlternative Defines an alternative path for a specific language.
LogisticsProvider List of Logistics providers.
LowestPrice
Media
Offer
PathInfo The target destination of a path.
PayType
PaymentMethod Defines a payment method that can be used to accept payments.
PhysicalStore Defines a physical store, containing contact details, geographical location and opening hours.
PhysicalStoreStockBalance Contains information about stock balances for a physical store. The stock balance information is separated by stock keeping units.
PhysicalStoreStockKeepingUnit Information about the quantity in stock of a specific stock keeping unit.
Price
PriceCampaign
PriceRangeFilter
PriceType
Product
ProductDetailRequest Defines a request for getting the details of a product
ProductDetailResponse Holds information about a product detail response
ProductFeedRequest Defines a request for getting a list of products
ProductFeedResponse
ProductForFeed
ProductListRequest Defines a request for getting a list of products
ProductListResponse Holds information about a product list response
ProductSearchRequest Defines a request for searching for products
ProductSource
ProductType
Property
Property
PropertyBucket
PropertyBucketItem
PropertyFilter
PropertyValue
PurchaseResultAction Defines various purchase result actions.
QueryRequest Contains information required to perform a dynamic data query to ETM.
QueryResponse Contains the result of a dynamic query.
RawPurchaseFlexibleSubscription Raw purchase row for creating flexible subscriptions from a template.
RawPurchaseFlexibleSubscriptionRow A row of a raw purchase will result in a flexible subscription row. It has a stock keeping unit with the given quantity. Price information and potential discount is also provided.
RawPurchaseOrderRow A row of a raw purchase will result in a regular order row. It has a stock keeping unit with the given quantity. Price information and potential discount is also provided.
RawPurchasePaymentReference Represents a transaction of a payment.
RawPurchaseRequest A raw purchase contains all the necessary information for the order chain. It contains information about the customer, including contact information and shipping details. It contains content information, such as regular order information, with fees and rows, but also potential subscriptions. It contains information about how payments are handled and how deliveries are handled.
RawPurchaseResponse Contains the response from Raw Purchase API.
RawPurchaseSubscriptionDiscount Raw purchase subscription discount.
RawPurchaseSubscriptionRow Raw purchase row for creating subscriptions from a template.
Receipt Defines a receipt for an order online.
ReceiptAddOn Defines a single add-on row that belongs to a receipt row.
ReceiptAddOnValue Defines value details for receipt rows.
ReceiptCustomer Holds information about the customer of a receipt.
ReceiptDeliveryMethod Contains information about the delivery method of a receipt.
ReceiptOffer Contains information about a head-level offer of a receipt.
ReceiptPaymentMethod Contains information about the payment method of a receipt.
ReceiptRental Defines a single rental of a receipt.
ReceiptRentalAddOn Defines a single add-on row that belongs to a rental.
ReceiptRentalValue Defines value details for receipt rows.
ReceiptRow Defines a single order row of a receipt.
ReceiptRowValue Defines value details for receipt rows.
ReceiptSubscription Defines a single subscription of a receipt.
ReceiptUsedVoucher Contains information about used vouchers (gift cards).
ReceiptValue Defines value details for receipts.
Referral Defines a referral from one customer to a (potentially) new customer.
RelationProduct
RelationType
Relations
RentalInfo
Seller Defines a seller.
ServiceProviderConfiguration Defines a service provider configuration. A Service provider configuration are usually used when communication with third parties.
ServiceProviderConfigurationParameter Defines a service provider configuration parameter.
Sex Represents a customers sex
Sort
Stock
StockKeepingUnit
StockKeepingUnitStatus
StockState
StoreSetting Holds a single setting for a web store. A setting can be anything from external tokens (such as the Google Analytics token) to simple styling settings (such as font names or colors).
StreamlineExpressRequest Defines a request to the Streamline Express service. This information contains the page to use together with optional overrides (such as payment method to use) in addition to the customer information that should be used when creating the purchase.
StreamlineExpressResponse Defines a response from the Streamline Express service.
SubmitParameter Represents a submit parameter. It is a simple key/value pair that is retrieved n the result when creating new purchases.
TargetType Defines the type of the path destination target.
TaxRateAddressRequest The address for the tax rate calculation.
TaxRateFeeResponse Response with calculated tax rate for different fees, i.e. shipping fee, payment fee, etc.
TaxRateLineRequest Lines for CalculateTaxRateRequest representing each product we need to calculate tax for.
TaxRateLineResponse Lines for CalculateTaxRateRequest representing each product we calculated tax for.
TaxRateRequest Request to calculate the tax rate based on passed SKUs/PLU numbers.
TaxRateResponse Response with calculated tax rate for the passed SKUs/PLU numbers.
TimeSlot Defines a time slot.
TimeSlotRule Controls the rules for time slots of a delivery method.
TransactionType