API Conversions and Product catalog
Commanders Act Data API v2.0.0
Faites défiler vers le bas pour des exemples de code, des requêtes et réponses exemples. Sélectionnez une langue pour les exemples de code dans les onglets ci‑dessous ou dans le menu de navigation mobile.
Il est fortement recommandé d'envoyer plusieurs objets dans une seule requête HTTP. Cette API permet le streaming en utilisant le format JSON séparé par des nouvelles lignes ou ndjson (http://ndjson.org/)
Limites de débit
Vous pouvez envoyer jusqu'à 30 requêtes par seconde
Vous pouvez avoir jusqu'à 30 connexions simultanées
Si vous envoyez de nombreuses conversions/produits/etc. en masse, la vitesse de téléversement sera limitée à 30 conversions/produits/etc. par seconde
Exemples de limitation de débit
Si vous envoyez 1 conversion par requête, vous serez limité à 30 requêtes par seconde
Si vous envoyez 90 conversions dans une seule requête, votre téléversement sera effectué en environ 3 secondes
Si vous envoyez 40 requêtes, chacune avec une conversion dans la même seconde, 30 d'entre elles seront traitées et 10 seront rejetées
Si vous envoyez 3 requêtes, chacune avec 100 conversions, elles seront terminées en 10 secondes
Limitations
Vous pouvez envoyer jusqu'à 150 éléments de conversion
Formats de date
Utilisez le format long avec fuseau horaire pour transmettre des dates ISO-8601. Les formats suivants sont acceptés :
"2019-04-29T13:47:47.315Z"
"2019-04-29T13:47:47Z"
"2019-04-29T13:47:47.315+02:00"
"2019-04-29T13:47:47+02:00"
Errors
Les erreurs sont toujours renvoyées sous forme de tableau d'objets dans la propriété de niveau supérieur "errors".
Erreurs dans les opérations en masse
Pour les opérations en masse, vous pouvez avoir des propriétés "errors" et "data" en même temps puisque certains objets peuvent contenir des erreurs alors que d'autres non. Les erreurs en masse sont agrégées, ce qui signifie qu'il n'y aura pas une erreur pour chaque instance mais une erreur par type avec le nombre d'occurrences et quelques exemples de numéros de ligne ou d'IDs.
{
"errors": [
{
"code": "YOU_CAN_CHECK_THIS_IN_CODE",
"detail": "This explains the error",
"meta": {
"context_property_example": "value_example",
"error_count": 3,
"line_numbers": [34, 45],
"ids": [
"c9017b85-8016-4f13-88b4-18d57c67b866",
"12e0c3cb-7e8d-462f-9232-f7c61a900738"
]
}
}
]
"data": {
"accepted_object_count": 4,
"rejected_object_count": 3
}
}Objet d'erreur
Les objets d'erreur ont les propriétés suivantes
code
string
true
Toujours présent et contient le code d'erreur pouvant être vérifié programmaticalement
detail
string
true
Message lisible par un humain qui explique le problème. Vous ne devez pas vérifier la valeur de cette propriété de manière programmatique car elle peut changer
meta
object
false
Objet spécifique à l'erreur qui contient des détails sur ce qui a généré l'erreur
URLs de base :
Authentication
Authentification HTTP, schéma : bearer Le Token sera fourni par notre équipe support/consulting
Par défaut
Upsert des conversions
Exemples de code
POST https://api.commander1.com/v2/{siteId}/conversions/bulk HTTP/1.1
Host: api.commander1.com
Content-Type: application/x-ndjson
Accept: application/json
Authorization: Bearer NJtcKaoCYu...mGZDxRgMBMUw==POST /conversions/bulk
Ce endpoint crée et met à jour des conversions. Votre requête sera traitée de façon asynchrone. Le traitement peut prendre jusqu'à 1 heure avant que les mises à jour ne soient effectuées dans la base de données.
Paramètre Body
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","user":{"user_email":"[email protected]"},"type":"offline","status":"in_progress","created":"2018-01-01T20:00:00.000+01:00","updated":"2018-01-01T20:00:00.000+01:00","acknowledged":true,"currency":"EUR","comment":"Package needs to be smaller than 30cm by 30cm","billing_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"contact_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_provider":"UPS","shipping_tracking_code":"702c7a16-2c3d-4946-bb35-69ba540773f6","payment_method":"card","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"shipping_amount":0,"discount_amount":0,"tax_amount":5,"final_amount":10,"custom":{"internal_reference":"fa34dc2","referer":"[email protected]","website_version":"2.4"},"conversion_items":[{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}},{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}}]}
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","user":{"user_email":"[email protected]"},"type":"offline","status":"in_progress","created":"2018-01-01T20:00:00.000+01:00","updated":"2018-01-01T20:00:00.000+01:00","acknowledged":true,"currency":"EUR","comment":"Package needs to be smaller than 30cm by 30cm","billing_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"contact_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_provider":"UPS","shipping_tracking_code":"702c7a16-2c3d-4946-bb35-69ba540773f6","payment_method":"card","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"shipping_amount":0,"discount_amount":0,"tax_amount":5,"final_amount":10,"custom":{"internal_reference":"fa34dc2","referer":"[email protected]","website_version":"2.4"},"conversion_items":[{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}},{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}}]}
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","user":{"user_email":"[email protected]"},"type":"offline","status":"in_progress","created":"2018-01-01T20:00:00.000+01:00","updated":"2018-01-01T20:00:00.000+01:00","acknowledged":true,"currency":"EUR","comment":"Package needs to be smaller than 30cm by 30cm","billing_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"contact_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_provider":"UPS","shipping_tracking_code":"702c7a16-2c3d-4946-bb35-69ba540773f6","payment_method":"card","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"shipping_amount":0,"discount_amount":0,"tax_amount":5,"final_amount":10,"custom":{"internal_reference":"fa34dc2","referer":"[email protected]","website_version":"2.4"},"conversion_items":[{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}},{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}}]}Paramètres
Authorization
en-tête
string
true
jeton d'Authorization
overwrite
query
boolean
false
Détermine si les conversions doivent être entièrement remplacées (true) ou partiellement mises à jour (false - par défaut).
Comportement du paramètre Overwrite
La méthode overwrite Le paramètre url détermine la façon dont les conversions sont traitées lorsqu'un id est trouvé :
false(par défaut):Seuls les champs spécifiés seront mis à jour.
Les champs non spécifiés conserveront leurs valeurs existantes.
true:La conversion existante sera entièrement remplacée par les nouvelles données fournies.
Si vous devez remplacer entièrement une conversion, définissez overwrite=true.
Exemples de réponses
Réponse 202
{
"data": {
"accepted_object_count": 4,
"rejected_object_count": 0
}
}400 Impossible d'analyser la ligne nd-json
{
"errors": [
{
"code": "PARSE_ERROR",
"detail": "Cannot parse nd-json"
}
],
"data": {}
}400 Propriété requise manquante
{
"errors": [
{
"code": "MISSING_REQUIRED_PROPERTY",
"detail": "should have required property 'id'\n",
"meta": {
"line_numbers": [
34,
45
],
"error_count": 2,
"ids": [
"c9017b85-8016-4f13-88b4-18d57c67b866",
"12e0c3cb-7e8d-462f-9232-f7c61a900738"
]
}
}
],
"data": {
"accepted_object_count": 4,
"rejected_object_count": 2
}
}400 Type de propriété invalide
{
"errors": [
{
"code": "INVALID_PROPERTY_TYPE",
"detail": "\"original_amount\" property is not a number",
"meta": {
"property": "original_amount",
"line_numbers": [
34,
45
],
"error_count": 2,
"ids": [
"c9017b85-8016-4f13-88b4-18d57c67b866",
"12e0c3cb-7e8d-462f-9232-f7c61a900738"
]
}
}
],
"data": {
"accepted_object_count": 4,
"rejected_object_count": 2
}
}400 Format de propriété invalide
{
"errors": [
{
"code": "INVALID_PROPERTY_FORMAT",
"detail": "\"original_amount\" property is not a number",
"meta": {
"property": "original_amount",
"line_numbers": [
34,
45
],
"error_count": 2,
"ids": [
"c9017b85-8016-4f13-88b4-18d57c67b866",
"12e0c3cb-7e8d-462f-9232-f7c61a900738"
]
}
}
],
"data": {
"accepted_object_count": 4,
"rejected_object_count": 2
}
}401 L'en-tête Authorization est manquant
{
"errors": [
{
"code": "MISSING_AUTHORIZATION_HEADER",
"detail": "The \"Authorization\" header is required"
}
]
}401 Le type de token est manquant
{
"errors": [
{
"code": "UNKNOWN_TOKEN_TYPE",
"detail": "The token type is missing"
}
]
}401 Le type de token est invalide
{
"errors": [
{
"code": "INVALID_TOKEN_TYPE",
"detail": "The token type \"Bear\" is invalid. Expecting \"Bearer\" instead"
}
]
}401 Le token fourni est inconnu
{
"errors": [
{
"code": "UNKNOWN_TOKEN",
"detail": "The provided token is unknown. Please contact our support team [email protected]"
}
]
}403 Réponse
{
"errors": [
{
"code": "SITE_ACCESS_FORBIDDEN",
"detail": "You cannot access this site"
}
]
}Trop de requêtes
{
"description": "You have too many open connections",
"errors": [
{
"code": "CONNECTION_LIMIT_REACHED",
"detail": "Your account is limited to 30 simultaneous connections"
}
]
}{
"description": "You have reached the request limit",
"errors": [
{
"code": "REQUEST_LIMIT_REACHED",
"detail": "Your account is limited to 30 requests per second"
}
]
}500 Réponse
{
"errors": [
{
"code": "SERVER_ERROR",
"detail": "An internal error occurred. Please contact our support team [email protected]"
}
]
}Réponses
400
Impossible de traiter la requête ou une partie de celle‑ci en raison d'une erreur client
None
Schéma de réponse
Upsert des produits
Exemples de code
POST https://api.commander1.com/v2/{siteId}/products/bulk HTTP/1.1
Host: api.commander1.com
Content-Type: application/x-ndjson
Authorization: Bearer NJtcKaoCYu...mGZDxRgMBMUw==POST /products/bulk
Ce endpoint crée et met à jour des produits. Votre requête sera traitée de façon asynchrone. Le traitement peut prendre jusqu'à 24 heures avant que les mises à jour ne soient effectuées dans la base de données.
Paramètre Body
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}Paramètres
Authorization
en-tête
string
true
jeton d'Authorization
Réponses
Schémas
Conversion
{
"id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
"user": {
"email": "[email protected]",
"consent_categories": [1,3]
},
"type": "offline",
"status": "in_progress",
"created": "2018-01-01T20:00:00.000+01:00",
"updated": "2018-01-01T20:00:00.000+01:00",
"acknowledged": true,
"currency": "EUR",
"comment": "Package needs to be smaller than 30cm by 30cm",
"billing_address": {
"country": "France",
"iso_country_code": "FR",
"country_code": "FRA",
"region": "Ile-de-France",
"locality": "Paris",
"postal_code": "75009",
"recipient": "Commanders Act",
"street_address": "3-5 Rue Saint-Georges",
"full_address": null,
"label": "home",
"coordinates": {
"latitude": 48.857764,
"longitude": 2.33935
}
},
"contact_address": {
"country": "France",
"iso_country_code": "FR",
"country_code": "FRA",
"region": "Ile-de-France",
"locality": "Paris",
"postal_code": "75009",
"recipient": "Commanders Act",
"street_address": "3-5 Rue Saint-Georges",
"full_address": null,
"label": "home",
"coordinates": {
"latitude": 48.857764,
"longitude": 2.33935
}
},
"shipping_address": {
"country": "France",
"iso_country_code": "FR",
"country_code": "FRA",
"region": "Ile-de-France",
"locality": "Paris",
"postal_code": "75009",
"recipient": "Commanders Act",
"street_address": "3-5 Rue Saint-Georges",
"full_address": null,
"label": "home",
"coordinates": {
"latitude": 48.857764,
"longitude": 2.33935
}
},
"shipping_provider": "UPS",
"shipping_tracking_code": "702c7a16-2c3d-4946-bb35-69ba540773f6",
"payment_method": "card",
"original_quantity": 3,
"cancelled_quantity": 1,
"returned_quantity": 1,
"exchanged_quantity": 0,
"final_quantity": 1,
"original_amount": 30,
"cancelled_amount": 10,
"returned_amount": 10,
"exchanged_amount": 0,
"shipping_amount": 0,
"discount_amount": 0,
"tax_amount": 5,
"final_amount": 10,
"custom": {
"internal_reference": "fa34dc2",
"referer": "[email protected]",
"website_version": "2.4"
},
"conversion_items": [
{
"id": "68cd1310-4b7a-454c-99fb-2510f0e156ec",
"original_quantity": 3,
"cancelled_quantity": 1,
"returned_quantity": 1,
"exchanged_quantity": 0,
"final_quantity": 1,
"original_amount": 30,
"cancelled_amount": 10,
"returned_amount": 10,
"exchanged_amount": 0,
"final_amount": 10,
"price": 10,
"original_item": true,
"custom": {
"remarketing_campaign": "christmas_2018",
"time_to_checkout": "25 minutes",
"ab_testing_group": "3245fcda"
},
"product": {
"id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
"name": "Mug Commanders Act",
"description": "White stoneware mug with C-Handle is the perfect cup for any beverage",
"category_1": "Home",
"category_2": "Kitchen",
"category_3": "Accessories",
"category_4": "Containers",
"category_5": "Mugs",
"tags": [
"mugs",
"handle",
"white",
"brand"
],
"condition": "new",
"availability": "in_stock",
"availability_date": "2019-02-06T17:41:31.427+01:00",
"expiration_date": "2019-02-06T17:41:31.427+01:00",
"price": 10,
"sale_price": 8,
"currency": "EUR",
"image_link": "https://commandersact.com/images/shopping/mug_hi_res.jpg",
"link": "https://commandersact.com/shopping/mug",
"brand": "Commanders Act",
"width": 6.4,
"length": 7.3,
"height": 9.5,
"weight": 80.7,
"size": "medium",
"colors": [
"white",
"red"
],
"gtin": "134588842456789000",
"mpn": "134588842",
"custom": {
"internal_category_id": 721,
"warehouse": "building B",
"box_barcode": 1830135586179
}
}
},
{
"id": "68cd1310-4b7a-454c-99fb-2510f0e156ec",
"original_quantity": 3,
"cancelled_quantity": 1,
"returned_quantity": 1,
"exchanged_quantity": 0,
"final_quantity": 1,
"original_amount": 30,
"cancelled_amount": 10,
"returned_amount": 10,
"exchanged_amount": 0,
"final_amount": 10,
"price": 10,
"original_item": true,
"custom": {
"remarketing_campaign": "christmas_2018",
"time_to_checkout": "25 minutes",
"ab_testing_group": "3245fcda"
},
"product": {
"id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
"name": "Mug Commanders Act",
"description": "White stoneware mug with C-Handle is the perfect cup for any beverage",
"category_1": "Home",
"category_2": "Kitchen",
"category_3": "Accessories",
"category_4": "Containers",
"category_5": "Mugs",
"tags": [
"mugs",
"handle",
"white",
"brand"
],
"condition": "new",
"availability": "in_stock",
"availability_date": "2019-02-06T17:41:31.427+01:00",
"expiration_date": "2019-02-06T17:41:31.427+01:00",
"price": 10,
"sale_price": 8,
"currency": "EUR",
"image_link": "https://commandersact.com/images/shopping/mug_hi_res.jpg",
"link": "https://commandersact.com/shopping/mug",
"brand": "Commanders Act",
"width": 6.4,
"length": 7.3,
"height": 9.5,
"weight": 80.7,
"size": "medium",
"colors": [
"white",
"red"
],
"gtin": "134588842456789000",
"mpn": "134588842",
"custom": {
"internal_category_id": 721,
"warehouse": "building B",
"box_barcode": 1830135586179
}
}
}
]
}Il est recommandé d'utiliser autant de champs que possible afin de pouvoir construire de bons segments avec des conditions avancées
Propriétés
id
string(1-50)
true
aucun
ID de conversion. Utilisé comme clé pour les mises à jour
user
object
true
aucun
Toutes les propriétés que vous ajoutez ici seront utilisées comme conditions pour l'appariement des utilisateurs dans notre base de données. Vous devez vous assurer que les valeurs utilisées dans ces propriétés sont uniques. Utilisez les mêmes noms de propriétés que ceux définis dans l'interface variables pour l'utilisateur.
» user.email
string(1-250)
false
aucun
Email de l'utilisateur
»user.consent_categories
string
false
aucun
Catégories de consentement de l'utilisateur, pour être autorisé à partager les conversions avec des partenaires
type
string(1-250)
true
aucun
Type de conversion (en ligne, offline, appel, etc.)
status
string
true
aucun
Statut de votre conversion (voir la liste des valeurs possibles ci‑dessous). Les conversions avec le statut "pending" ne sont pas incluses dans la somme par défaut et les comptes agrégés sur un utilisateur.
created
string(ISO-8601)
true
aucun
Moment où la conversion a eu lieu. Voir la section "Date formats" ci‑dessus pour la liste des formats autorisés.
updated
string(ISO-8601)
false
aucun
Moment où la conversion a été mise à jour. Voir la section "Date formats" ci‑dessus pour la liste des formats autorisés.
acknowledged
boolean
false
aucun
Définir à true si la conversion a été reconnue
currency
string(ISO-4217)
true
aucun
Devise
comment
string(1-250)
false
aucun
Commentaire de l'acheteur
billing_address
false
aucun
Il est recommandé d'utiliser autant de champs que possible afin de pouvoir construire de bons segments avec des conditions avancées
contact_address
false
aucun
Il est recommandé d'utiliser autant de champs que possible afin de pouvoir construire de bons segments avec des conditions avancées
shipping_address
false
aucun
Il est recommandé d'utiliser autant de champs que possible afin de pouvoir construire de bons segments avec des conditions avancées
shipping_provider
string(1-250)
false
aucun
Fournisseur de livraison
shipping_tracking_code
string(1-250)
false
aucun
Code de suivi d'expédition
payment_method
string
false
aucun
Type de méthode de paiement (voir la liste des valeurs possibles ci‑dessous)
payment_provider
string
false
aucun
Fournisseur de paiement utilisé pour cette transaction
original_quantity
float
false
lecture seule
Somme de tous les articles dans la conversion originale (CALCULÉ)
cancelled_quantity
float
false
lecture seule
Quantité d'articles annulés dans la conversion (CALCULÉ)
returned_quantity
float
false
lecture seule
Quantité d'articles retournés dans la conversion (CALCULÉ)
exchanged_quantity
float
false
lecture seule
Quantité d'articles échangés dans la conversion (CALCULÉ)
final_quantity
float
false
lecture seule
Quantité d'articles dans la transaction finale pour cette conversion (original_quantity - cancelled_quantity - returned_quantity - exchanged_quantity) (CALCULÉ)
original_amount
float
false
écriture unique
Montant original pour cette conversion (prix d'expédition et taxes inclus)
cancelled_amount
float
false
aucun
Montant annulé pour cette conversion
returned_amount
float
false
aucun
Montant retourné pour cette conversion
exchanged_amount
float
false
aucun
Montant échangé pour cette conversion
shipping_amount
float
false
aucun
Montant de l'expédition pour cette conversion
discount_amount
float
false
aucun
Montant de la réduction pour cette conversion
tax_amount
float
false
aucun
Tax amount for this conversion
final_amount
float
false
aucun
Montant final pour cette conversion après retours, échanges, annulations, etc. (prix d'expédition et taxes inclus). Cela représente le montant global de la transaction entre l'acheteur et le vendeur
personnalisées
object
false
aucun
Objet contenant des propriétés personnalisées
conversion_items
true
aucun
Liste des produits dans la conversion + leurs propres attributs. Vous ne pouvez pas avoir le même produit deux fois dans une conversion à moins de fournir un id d'élément de conversion
Valeurs énumérées
status
canceled
status
delivered
status
in_progress
status
partially_delivered
status
partially_returned
status
partially_shipped
status
pending_shipment
status
returned
status
shipped
status
pending
payment_method
by_bank_transfer_in_advance
payment_method
by_invoice
payment_method
card
payment_method
check_in_advance
payment_method
cod
payment_method
coupon
payment_method
direct_debit
payment_method
online_payment_system
payment_method
other
ConversionItem
{
"id": "68cd1310-4b7a-454c-99fb-2510f0e156ec",
"original_quantity": 3,
"cancelled_quantity": 1,
"returned_quantity": 1,
"exchanged_quantity": 0,
"final_quantity": 1,
"original_amount": 30,
"cancelled_amount": 10,
"returned_amount": 10,
"exchanged_amount": 0,
"final_amount": 10,
"price": 10,
"original_item": true,
"custom": {
"remarketing_campaign": "christmas_2018",
"time_to_checkout": "25 minutes",
"ab_testing_group": "3245fcda"
},
"product": {
"id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
"name": "Mug Commanders Act",
"description": "White stoneware mug with C-Handle is the perfect cup for any beverage",
"category_1": "Home",
"category_2": "Kitchen",
"category_3": "Accessories",
"category_4": "Containers",
"category_5": "Mugs",
"tags": [
"mugs",
"handle",
"white",
"brand"
],
"condition": "new",
"availability": "in_stock",
"availability_date": "2019-02-06T17:41:31.427+01:00",
"expiration_date": "2019-02-06T17:41:31.427+01:00",
"price": 10,
"sale_price": 8,
"currency": "EUR",
"image_link": "https://commandersact.com/images/shopping/mug_hi_res.jpg",
"link": "https://commandersact.com/shopping/mug",
"brand": "Commanders Act",
"width": 6.4,
"length": 7.3,
"height": 9.5,
"weight": 80.7,
"size": "medium",
"colors": [
"white",
"red"
],
"gtin": "134588842456789000",
"mpn": "134588842",
"custom": {
"internal_category_id": 721,
"warehouse": "building B",
"box_barcode": 1830135586179
}
}
}Il est recommandé d'utiliser autant de champs que possible afin de pouvoir construire de bons segments avec des conditions avancées
Propriétés
id
string
true
aucun
ID de cet article dans la conversion. Cet id est requis. Si vous n'avez pas d'id d'article dans votre base et que le même product id ne peut pas se répéter dans une conversion, vous pouvez utiliser le product id comme valeur. Ce champ est utilisé pour identifier l'article lors des mises à jour.
original_quantity
float
true
aucun
Quantité d'articles dans la conversion originale
cancelled_quantity
float
false
aucun
Quantité d'articles annulés
returned_quantity
float
false
aucun
Quantité d'articles retournés
exchanged_quantity
float
false
aucun
Quantité d'articles échangés
final_quantity
float
false
aucun
Quantité d'articles dans la transaction finale (original_quantity - cancelled_quantity - returned_quantity - exchanged_quantity)
original_amount
float
false
aucun
Montant original pour cet article
cancelled_amount
float
false
aucun
Montant annulé pour cet article
returned_amount
float
false
aucun
Montant retourné pour cet article
exchanged_amount
float
false
aucun
Montant échangé pour cet article
final_amount
float
false
aucun
Montant final pour cet article (original_amount - cancelled_amount - returned_amount - exchanged_amount)
price
float
false
aucun
Prix de l'article (en utilisant la même currency que pour la conversion)
original_item
boolean
false
aucun
Si cet article était présent dans la conversion originale. Ceci est automatiquement mis à false pour tous les articles ajoutés lors des mises à jour de conversion
personnalisées
object
false
aucun
Objet contenant des propriétés personnalisées
product
true
aucun
Il y a trois façons d'avoir l'information produit dans vos conversion items. La première méthode consiste à mettre les propriétés produit inline pour chaque conversion item. La deuxième méthode consiste à synchroniser votre catalogue produit avec notre base en utilisant le endpoint "POST /products/bulk" et n'envoyer que les product ids dans les conversion items (notre serveur copiera les propriétés produit depuis le catalogue). La troisième méthode est une combinaison des précédentes et implique d'avoir un catalogue produit et d'envoyer l'information produit inline. Dans le cas où une propriété est présente à la fois dans le produit du catalogue et dans le produit inline, les propriétés du produit inline écraseront celles du catalogue. Cette méthode est utile lorsque l'information produit est incomplète ou complémentaire dans les produits inline. Il est recommandé d'envoyer les produits inline, sauf lorsque vous ne disposez pas de toutes les informations produit. Dans la plupart des cas, vous n'avez pas besoin d'utiliser le catalogue. Il est recommandé d'utiliser autant de champs que possible afin de pouvoir construire de bons segments avec des conditions avancées. Lorsque vous n'envoyez que l'id du produit dans un conversion item, vous devez vous assurer que votre catalogue contient déjà le produit, sinon les propriétés du produit ne seront pas ajoutées à votre conversion item.
Adresse
{
"country": "France",
"iso_country_code": "FR",
"country_code": "FRA",
"region": "Ile-de-France",
"locality": "Paris",
"postal_code": "75009",
"recipient": "Commanders Act",
"street_address": "3-5 Rue Saint-Georges",
"full_address": null,
"label": "home",
"coordinates": {
"latitude": 48.857764,
"longitude": 2.33935
}
}Il est recommandé d'utiliser autant de champs que possible afin de pouvoir construire de bons segments avec des conditions avancées
Propriétés
country
string(1-250)
false
aucun
Nom lisible du pays
iso_country_code
string(ISO-3166)
false
aucun
Code pays ISO-3166
country_code
string
false
aucun
Utilisez ce champ au cas où vous utilisez des codes pays autres que ISO-3166
region
string(1-250)
false
aucun
Région administrative
locality
string(1-250)
false
aucun
Nom de la ville/commune/village, etc.
postal_code
string(1-250)
false
aucun
Code postal
recipient
string(1-250)
false
aucun
Nom du destinataire
street_address
string(1-250)
false
aucun
Nom de rue, numéro, numéro de bâtiment, etc.
full_address
string(1-250)
false
aucun
Adresse complète sous forme de chaîne pouvant contenir des sauts de ligne. Non utilisable en segmentation mais disponible pour les exports
label
string(1-250)
false
aucun
Étiquette pour cette adresse (home, work, etc.)
coordinates
object
false
aucun
Coordonnées pour cette adresse
» latitude
float
false
aucun
Latitude
» longitude
float
false
aucun
Longitude
Product
{
"id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
"name": "Mug Commanders Act",
"description": "White stoneware mug with C-Handle is the perfect cup for any beverage",
"category_1": "Home",
"category_2": "Kitchen",
"category_3": "Accessories",
"category_4": "Containers",
"category_5": "Mugs",
"tags": [
"mugs",
"handle",
"white",
"brand"
],
"condition": "new",
"availability": "in_stock",
"availability_date": "2019-02-06T17:41:31.427+01:00",
"expiration_date": "2019-02-06T17:41:31.427+01:00",
"price": 10,
"sale_price": 8,
"currency": "EUR",
"image_link": "https://commandersact.com/images/shopping/mug_hi_res.jpg",
"link": "https://commandersact.com/shopping/mug",
"brand": "Commanders Act",
"width": 6.4,
"length": 7.3,
"height": 9.5,
"weight": 80.7,
"size": "medium",
"colors": [
"white",
"red"
],
"gtin": "134588842456789000",
"mpn": "134588842",
"custom": {
"internal_category_id": 721,
"warehouse": "building B",
"box_barcode": 1830135586179
}
}Il y a trois façons d'avoir l'information produit dans vos conversion items. La première méthode consiste à mettre les propriétés produit inline pour chaque conversion item. La deuxième méthode consiste à synchroniser votre catalogue produit avec notre base en utilisant le endpoint "POST /products/bulk" et n'envoyer que les product ids dans les conversion items (notre serveur copiera les propriétés produit depuis le catalogue). La troisième méthode est une combinaison des précédentes et implique d'avoir un catalogue produit et d'envoyer l'information produit inline. Dans le cas où une propriété est présente à la fois dans le produit du catalogue et dans le produit inline, les propriétés du produit inline écraseront celles du catalogue. Cette méthode est utile lorsque l'information produit est incomplète ou complémentaire dans les produits inline. Il est recommandé d'envoyer les produits inline, sauf lorsque vous ne disposez pas de toutes les informations produit. Dans la plupart des cas, vous n'avez pas besoin d'utiliser le catalogue. Il est recommandé d'utiliser autant de champs que possible afin de pouvoir construire de bons segments avec des conditions avancées. Lorsque vous n'envoyez que l'id du produit dans un conversion item, vous devez vous assurer que votre catalogue contient déjà le produit, sinon les propriétés du produit ne seront pas ajoutées à votre conversion item.
Propriétés
id
string(1-50)
true
aucun
Identifiant unique pour l'article (essayez d'utiliser l'identifiant le plus précis ou le SKU), tel qu'une référence. S'il y a plusieurs occurrences du même identifiant, seule la dernière sera enregistrée
name
string(1-500)
false
aucun
Nom de l'article
description
string(max 5000 chars)
false
aucun
Description de l'article
category_1
string(1-250)
false
aucun
Catégorie principale de l'article
category_2
string(1-250)
false
aucun
Deuxième sous-catégorie de l'article
category_3
string(1-250)
false
aucun
Troisième sous-catégorie de l'article
category_4
string(1-250)
false
aucun
Quatrième sous-catégorie de l'article
category_5
string(1-250)
false
aucun
Cinquième sous-catégorie de l'article. Si vous avez plus de cinq niveaux de catégorie, vous pouvez choisir de concaténer les niveaux restants comme 'Bikes/Parts/Wheels/Front' ou simplement ignorer les niveaux restants comme 'Bikes', selon vos besoins de segmentation.
tags
[string]
false
aucun
Tableau de tags pour le produit. Les tags peuvent être n'importe quoi qui étiquette le produit : fait main, éco-responsable, résistant à la chaleur, etc.
condition
string
false
aucun
Statut actuel du produit dans votre boutique (voir la liste des valeurs possibles ci‑dessous)
availability
string
false
aucun
Disponibilité actuelle de l'article dans votre boutique. Assurez-vous d'indiquer la disponibilité de l'article sur la page produit et de la tenir à jour (voir la liste des valeurs possibles ci‑dessous)
availability_date
string(ISO-8601)
false
aucun
Date à laquelle le produit est devenu ou deviendra disponible. Voir la section "Date formats" ci‑dessus pour la liste des formats autorisés.
expiration_date
string(ISO-8601)
false
aucun
Date à laquelle le produit est devenu ou deviendra indisponible. Voir la section "Date formats" ci‑dessus pour la liste des formats autorisés.
price
float
false
aucun
Prix par défaut de l'article. Dans une conversion, vous pouvez spécifier le prix réel auquel l'article a été vendu en cas de ventes, réductions, etc.
sale_price
float
false
aucun
Prix par défaut de l'article pendant les périodes de soldes. Dans une conversion, vous pouvez spécifier le prix réel auquel l'article a été vendu en cas de réductions
currency
string(ISO-4217)
false
aucun
Currency used for given prices. Note that you have to use the same currency for products and conversions
image_link
string(url)
false
aucun
URL de l'image du produit
link
string(url)
false
aucun
URL du site où vous pouvez acheter l'article
brand
string(1-250)
false
aucun
Marque de l'article
width
float
false
aucun
Largeur de l'article en centimètres (cm)
length
float
false
aucun
Longueur de l'article en centimètres (cm)
height
float
false
aucun
Hauteur de l'article en centimètres (cm)
weight
float
false
aucun
Poids de l'article en grammes
size
string(1-250)
false
aucun
Taille de l'article lorsque largeur, hauteur et longueur ne sont pas applicables. Vous pouvez utiliser toute valeur qui décrit la taille. Exemples : S, XL, large
colors
[string]
false
aucun
Couleurs du produit
gender
string(1-250)
false
aucun
Genre pour produits spécifiques (male, female, unisex)
gtin
string(1-250)
false
aucun
Numéro d'identification commerciale international de l'article. Nombres supportés : UPC (Amérique du Nord, 12 chiffres), EAN (Europe, 13 chiffres), JAN (Japon, 8 à 13 chiffres), ISBN (livres, 13 chiffres)
mpn
string(1-250)
false
aucun
Numéro de pièce du fabricant du produit
personnalisées
object
false
aucun
Objet contenant des propriétés personnalisées
Valeurs énumérées
condition
new
condition
refurbished
condition
used
availability
in_stock
availability
available
availability
pre_order
availability
out_of_stock
gender
male
gender
female
gender
unisex
Mis à jour
Ce contenu vous a-t-il été utile ?