This schema is used internally by Spark, not for OpCo integration.
Marketplace offer with the action on it
This schema is used internally by Spark, not for OpCo integration.
Marketplace offer with the action on it
{
"action": "UPSERT",
"offer": {
"offerId": "2013",
"lastUpdate": "2023-02-27T23:00:00Z",
"offerInfo": {
"isActive": true,
"description": {
"de-CH": "ein Text in Schweizerdeutsch",
"fr-FR": "un texte en français"
},
"availableFrom": "2022-12-31T23:00:00Z",
"availableTo": "2023-02-27T23:00:00Z"
},
"offerProduct": {
"identifier": {
"productId": "f721f482-f74c-491d-b5c1-74d2b114ed0f",
"productCondition": "NEW",
"leadtimeToShip": 1
},
"orderingDetail": {
"quantitySteps": 2,
"packingQuantity": 2,
"minQuantity": 5,
"maxQuantity": 20
},
"seller": {
"sellerId": "2009",
"sellerName": "Ampoules Cool",
"sellerSKU": "S2016",
"opcoSellerId": "shop-2009",
"isPremium": true,
"isProfessional": true
}
},
"offerPrice": {
"productPrices": {
"price": {
"amount": 2845,
"scale": 2,
"currency": "EUR"
},
"priceAdditionalInfo": {
"de-CH": "ein Text in Schweizerdeutsch",
"fr-FR": "un texte en français"
},
"discountStartDate": "2023-01-26T23:00:00Z",
"discountEndDate": "2023-02-26T23:00:00Z",
"discountPrice": {
"amount": 2500,
"scale": 2,
"currency": "EUR"
},
"ecoTaxes": [
{
"code": "FR-DEEE",
"taxAmount": {
"amount": 100,
"scale": 2,
"currency": "EUR"
}
}
]
},
"shippingFees": {
"minFeeAmount": {
"amount": 5,
"scale": 2,
"currency": "EUR"
},
"minAdditionalFeeAmount": {
"amount": 2,
"scale": 2,
"currency": "EUR"
},
"minShippingType": "STD",
"minShippingZone": "FRA"
}
},
"offerStock": {
"quantity": 15,
"unitOfMeasure": "TN",
"deliveryPromiseRange": {
"min": "P5D",
"max": "P7D"
}
}
}
}
{
"action": "DELETE",
"deletedOfferId": "2013"
}
Action defines if the offer has to be added/updated or deleted
Offer to create or update
No Additional PropertiesUnique offer identifier assigned by Mirakl.
Must be at least 1 characters long
"2013"
The last update date for this offer
"2023-02-27T23:00:00Z"
Offer info
No Additional PropertiesOffer description.
{
"de-CH": "ein Text in Schweizerdeutsch",
"fr-CH": "un texte en français suisse"
}
Each additional property must conform to the following schema
Type: stringIndicates if the offer is active
The date when the offer will be activated.
"2022-12-31T23:00:00Z"
The date when the offer will be deactivated.
"2023-02-27T23:00:00Z"
Details of an Offer
No Additional PropertiesIdentifier
No Additional PropertiesProduct identifier within the operator's system
Must be at least 1 characters long
"f721f482-f74c-491d-b5c1-74d2b114ed0f"
Offer condition code
"NEW"
The lead time to ship corresponding to the offer
1
Ordering detail
No Additional PropertiesPacking quantity of the product, if not present then the packing quantity is assumed to be equal to quantity steps
2
Quantity steps of the product.
2
The minimum order quantity customers must select to be able to place an order for that offer.
2
The maximum order quantity customers can select to be able to place an order for that offer.
20
The product measurement and the product unit in GS1 unit.
"TN"
The seller which is making the offer.
No Additional PropertiesUnique identifier for the store providing this offer (assigned by Mirakl).
Must be at least 1 characters long
"2009"
Name of the store providing this offer.
Must be at least 1 characters long
"Ampoules Cool"
Seller ID, as known by the opCo.
"shop-2009"
Shop's sku of the offer.
"S2016"
Indicates if the store is premium or not
false
Indicates if the store is professional or not
false
Information about the different prices of the offer.
No Additional PropertiesProduct price data of an offer
No Additional PropertiesOriginal price of the product on this offer (without discount)
the actual unscaled amount
205987
the scale to be applied on the unscaled amount
Value must be greater or equal to 0
2
the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Additional price information for the offer.
{
"de-CH": "ein Text in Schweizerdeutsch",
"fr-CH": "un texte en français suisse"
}
Each additional property must conform to the following schema
Type: stringThe start date of the discount period
"2023-01-26T23:00:00Z"
The end date of the discount period.
"2023-02-26T23:00:00Z"
The discount price of the product if applicable.
the actual unscaled amount
205987
the scale to be applied on the unscaled amount
Value must be greater or equal to 0
2
the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
List of eco-contribution amounts and corresponding producer identifiers, if applicable.
No Additional ItemsEco-contribution code and amount
Code of the eco tax
Must be at least 1 characters long
"FR-DEEE"
Amount of the eco tax
the actual unscaled amount
205987
the scale to be applied on the unscaled amount
Value must be greater or equal to 0
2
the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Tax code of the product.
Must be at least 1 characters long
"STANDARD_20%"
Shipping fees for this offer. The shipping fees are required only when the offer is active
No Additional PropertiesMinimal shipping charges for the offer
the actual unscaled amount
205987
the scale to be applied on the unscaled amount
Value must be greater or equal to 0
2
the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Additional minimal shipping charges for the offer.
the actual unscaled amount
205987
the scale to be applied on the unscaled amount
Value must be greater or equal to 0
2
the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Shipping method with the minimum shipping charges (code referenced by the operator).
Must be at least 1 characters long
"STD"
Shipping zone with the minimum shipping charges (code referenced by the operator).
Must be at least 1 characters long
"FRA"
Offer stock
No Additional PropertiesQuantity related to the offer.
15
The product measurement and the product unit in GS1 unit.
"TN"
Minimum and maximum duration in which the product can be delivered to the customer. We use the dur-day and the dur-week of the durations into ISO 8601 ABNF standard https://datatracker.ietf.org/doc/html/rfc3339#appendix-A
The minimal duration that this product will take to be delivered to the customer. We use the dur-day and the dur-week of the durations into ISO 8601 ABNF standard https://datatracker.ietf.org/doc/html/rfc3339#appendix-A
"P3D"
"P3W"
The maximal duration that this product will take to be delivered to the customer. We use the dur-day and the dur-week of the durations into ISO 8601 ABNF standard https://datatracker.ietf.org/doc/html/rfc3339#appendix-A
"P5D"
"P5W"
Offer id to delete in case of offer deletion