Code wiki

MIRAKL CODE : OF24

DESCRIPTION: Créer, mettre à jour ou supprimer une offre

URL STRUCTURE : {{URL}}/offers?api_key={{SHOP_KEY}}

METHOD : POST

QUERY PARAMETERS : shop_id - This parameter should be used when your user has access to multiple shops. If not mentioned, the shop_id from your default shop will be used.

INPUT : OffersBean - [required] List of representation of offers

JSON

XML

{
  "offers": [{     "available_ended": Date,     "available_started": Date,     "description": String,

"discount": {

"end_date": Date,

"price": Number,

"start_date": Date     },

"internal_description": String,

"logistic_class": String,

"min_quantity_alert": Number,

"offer_additional_fields": [{

"code": String,

"value": String     }],

"price": Number,

"price_additional_info": String,

"product_id": String,

"product_id_type": String,

"quantity": Number,

"shop_sku": String,

"state_code": String,

"update_delete": String   }]
 }

<body>
  <offers>
    <offer> [zero or N]

<available_ended>xsd:datetime</available_ended>

<available_started>xsd:datetime</available_started>

<description>xsd:string</description>

<discount>

<end_date>xsd:datetime</end_date>

<price>xsd:decimal</price>

<start_date>xsd:datetime</start_date>

</discount>

<internal_description>xsd:string</internal_description>

<logistic_class>xsd:string</logistic_class>

<min_quantity_alert>xsd:int</min_quantity_alert>

<offer_additional_fields>

<offer_additional_field> [zero or N]

<code>xsd:string</code>

<value>xsd:string</value>

</offer_additional_field>

</offer_additional_fields>

<price>xsd:decimal</price>

<price_additional_info>xsd:string</price_additional_info>

<product_id>xsd:string</product_id>

<product_id_type>xsd:string</product_id_type>

<quantity>xsd:int</quantity>

<shop_sku>xsd:string</shop_sku>

<state_code>xsd:string</state_code>

<update_delete>xsd:string</update_delete>

</offer>
  </offers>
</body>

Attributes details

Name	Type	Required	Nillable	Description
offers	offer [zero or N]	true	false
available_ended	xsd:datetime	true	true	End date of the period of availability
available_started	xsd:datetime	true	true	Started date of the period of availability
description	xsd:string	true	true	Description of the offer
discount	discount	false	true	Discount of an offer
end_date	xsd:datetime	false	true	Discount end date
price	xsd:decimal	false	true	Discount price
start_date	xsd:datetime	false	true	Discount start date
internal_description	xsd:string	true	true	Internal description of the offer
logistic_class	xsd:string	false	false
min_quantity_alert	xsd:int	true	true	Minimum quantity of the offer
offer_additional_fields	offer_additional_field[zero or N]	false	false	Additional fields of the offer
code	xsd:string	true	false	Code of the additional field
value	xsd:string	true	false	Value of the additional field
price	xsd:decimal	true	false	Price of the offer
price_additional_info	xsd:string	false	true	Price additional information of the offer
product_id	xsd:string	true	true	Reference of the product associated with the offer
product_id_type	xsd:string	true	true	Reference type of the product associated with the offer
quantity	xsd:int	true	false	Quantity available of the offer
shop_sku	xsd:string	true	false	Sku of the offer
state_code	xsd:string	true	false	State of the offer
update_delete	xsd:string	true	true	Update delete flag. Could be empty (means "update"), "update" or "delete".

OUTPUT : Offer import tracking information

JSON

XML

{
  "import_id": Number,
  "product_import_id": Number
 }

<offer_import_tracking>
  <import_id>xsd:long</import_id>
  <product_import_id>xsd:long</product_import_id>
</offer_import_tracking>

PRODUCES : application/json
application/xml

CONSUMES : application/json
application/xml

HTTP RETURN CODES : 201 - Success

HTTP RESPONSE HEADERS : Location - URL of the new import