> For the complete documentation index, see [llms.txt](https://doc.commandersact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.commandersact.com/fr/fonctionnalites/sources/sources-catalog/import-conversions/api-conversions-and-product-catalog.md).

# API Conversions et catalogue produit

Cette API est exclusivement destinée à envoyer des conversions et des produits vers la CDP de Commanders Act. Si vous souhaitez envoyer des événements d’achat côté serveur, consultez la  [page de la source HTTP tracking API](https://doc.commandersact.com/features/sources/sources-catalog/server/http-tracking-api) .

## Commanders Act Data API v2.0.0 <a href="#commanders-act-data-api" id="commanders-act-data-api"></a>

> Faites défiler la page pour consulter des exemples de code, des exemples de requêtes et de réponses. Sélectionnez une langue pour les exemples de code dans les onglets ci-dessus 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 au format JSON séparé par des sauts de ligne, ou ndjson (<http://ndjson.org/>)

### Limites de débit <a href="#rate-limits" id="rate-limits"></a>

* Vous pouvez envoyer jusqu’à 30 requêtes par seconde
* Vous pouvez avoir jusqu’à 30 connexions simultanées
* Si vous envoyez un grand nombre de conversions, de produits, etc. en masse, la vitesse d’envoi sera limitée à 30 conversions, produits, etc. par seconde

#### Exemples de limitation du débit <a href="#rate-limiting-examples" id="rate-limiting-examples"></a>

* Si vous envoyez une conversion par requête, vous serez limité à 30 requêtes par seconde
* Si vous envoyez 90 conversions dans une requête, leur envoi prendra environ 3 secondes
* Si vous envoyez 40 requêtes, chacune contenant une conversion, au cours de la même seconde, 30 seront traitées et 10 seront rejetées
* Si vous envoyez 3 requêtes contenant chacune 100 conversions, leur traitement prendra 10 secondes

### Limites

* Vous pouvez envoyer jusqu’à 150 éléments de conversion

### Formats de date <a href="#date-formats" id="date-formats"></a>

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"

### Erreurs <a href="#errors" id="errors"></a>

Les erreurs sont toujours renvoyées sous forme de tableau d’objets dans la propriété de premier niveau "errors".

#### Erreurs dans les opérations en masse <a href="#errors-in-bulk-operations" id="errors-in-bulk-operations"></a>

Dans les opérations en masse, les propriétés "errors" et "data" peuvent être présentes en même temps, car certains objets peuvent comporter des erreurs et d’autres non. Les erreurs en masse sont agrégées : une erreur n’est donc pas renvoyée pour chaque occurrence, mais une seule par type d’erreur, avec le nombre d’occurrences et quelques exemples de numéros de ligne ou d’identifiants.

```
{
  "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 <a href="#error-object" id="error-object"></a>

Les objets d’erreur possèdent les propriétés suivantes

| Propriété | Type   | Obligatoire | Description                                                                                                                                              |
| --------- | ------ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code      | string | true        | Toujours présent et contient le code d’erreur pouvant être vérifié par programmation                                                                     |
| 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é par programmation, car elle peut changer |
| meta      | object | false       | Objet spécifique à l’erreur contenant des détails sur son origine                                                                                        |

URL de base :

* [https://api.commander1.com/v2/{siteId}](https://api.commander1.com/v2/%7BsiteId%7D)

## Authentification <a href="#authentication" id="authentication"></a>

* Authentification HTTP, schéma : bearer. Le jeton sera fourni par notre équipe d’assistance/de conseil.

## Par défaut <a href="#commanders-act-data-api-default" id="commanders-act-data-api-default"></a>

### Créer ou mettre à jour des conversions <a href="#upsert-conversions" id="upsert-conversions"></a>

> 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 point de terminaison crée et met à jour des conversions. Votre requête sera traitée de manière asynchrone. Le traitement de la requête et la mise à jour de la base de données peuvent prendre jusqu’à une heure.

> Paramètre du corps

```
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","user":{"user_email":"user@example.com"},"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":"user@example.com","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":"user@example.com"},"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":"user@example.com","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":"user@example.com"},"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":"user@example.com","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 <a href="#upsert-conversions-parameters" id="upsert-conversions-parameters"></a>

| Nom           | Dans    | Type                           | Obligatoire | Description                                                                                                                            |
| ------------- | ------- | ------------------------------ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Authorization | en-tête | string                         | true        | Jeton d’autorisation                                                                                                                   |
| remplacer     | requête | booléen                        | false       | Détermine si les conversions doivent être entièrement remplacées (`true`) ou mises à jour partiellement (`false` - valeur par défaut). |
| corps         | corps   | [Conversion](#tocs_conversion) | true        | Conversions au format JSON délimité par des sauts de ligne                                                                             |

### Comportement du paramètre Overwrite

Le paramètre `overwrite` de l’URL détermine la manière dont les conversions sont traitées lorsqu’un `id` existant est trouvé :

* **`false`** *(par défaut)*:
  * Seuls les champs spécifiés seront mis à jour.
  * Les champs non spécifiés conservent leurs valeurs existantes.
* **`true`**:
  * La conversion existante sera **entièrement remplacée** par les nouvelles données fournies.

Pour 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 une ligne nd-json

```
{
  "errors": [
    {
      "code": "PARSE_ERROR",
      "detail": "Impossible d’analyser le nd-json"
    }
  ],
  "data": {}
}
```

> 400 Propriété requise manquante

```
{
  "errors": [
    {
      "code": "MISSING_REQUIRED_PROPERTY",
      "detail": "devrait contenir la propriété requise '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é non valide

```
{
  "errors": [
    {
      "code": "INVALID_PROPERTY_TYPE",
      "detail": "La propriété \"original_amount\" n’est pas un nombre",
      "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é non valide

```
{
  "errors": [
    {
      "code": "INVALID_PROPERTY_FORMAT",
      "detail": "La propriété \"original_amount\" n’est pas un nombre",
      "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 En-tête d’autorisation manquant

```
{
  "errors": [
    {
      "code": "MISSING_AUTHORIZATION_HEADER",
      "detail": "L’en-tête \"Authorization\" est requis"
    }
  ]
}
```

> 401 Type de jeton manquant

```
{
  "errors": [
    {
      "code": "UNKNOWN_TOKEN_TYPE",
      "detail": "Le type de jeton est manquant"
    }
  ]
}
```

> 401 Le type de jeton fourni n’est pas valide

```
{
  "errors": [
    {
      "code": "INVALID_TOKEN_TYPE",
      "detail": "Le type de jeton \"Bear\" n’est pas valide. Le type attendu est \"Bearer\""
    }
  ]
}
```

> 401 Le jeton fourni est inconnu

```
{
  "errors": [
    {
      "code": "UNKNOWN_TOKEN",
      "detail": "Le jeton fourni est inconnu. Veuillez contacter notre équipe d’assistance à l’adresse support@commandersact.com"
    }
  ]
}
```

> 403 Réponse

```
{
  "errors": [
    {
      "code": "SITE_ACCESS_FORBIDDEN",
      "detail": "Vous ne pouvez pas accéder à ce site"
    }
  ]
}
```

> Trop de requêtes

```
{
  "description": "Vous avez trop de connexions ouvertes",
  "errors": [
    {
      "code": "CONNECTION_LIMIT_REACHED",
      "detail": "Votre compte est limité à 30 connexions simultanées"
    }
  ]
}
```

```
{
  "description": "Vous avez atteint la limite de requêtes",
  "errors": [
    {
      "code": "REQUEST_LIMIT_REACHED",
      "detail": "Votre compte est limité à 30 requêtes par seconde"
    }
  ]
}
```

> 500 Réponse

```
{
  "errors": [
    {
      "code": "SERVER_ERROR",
      "detail": "Une erreur interne s’est produite. Veuillez contacter notre équipe d’assistance à l’adresse support@commandersact.com"
    }
  ]
}
```

#### Réponses <a href="#upsert-conversions-responses" id="upsert-conversions-responses"></a>

| Statut | Signification                                                                  | Description                                                                                   | Schéma |
| ------ | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | ------ |
| 202    | [Accepté](https://tools.ietf.org/html/rfc7231#section-6.3.3)                   | Tous les objets sont acceptés pour traitement                                                 | Aucun  |
| 400    | [Requête incorrecte](https://tools.ietf.org/html/rfc7231#section-6.5.1)        | Impossible de traiter la requête ou une partie de celle-ci en raison d’une erreur côté client | Aucun  |
| 401    | [Non autorisé](https://tools.ietf.org/html/rfc7235#section-3.1)                | Impossible d’identifier l’appelant de l’API                                                   | Aucun  |
| 403    | [Interdit](https://tools.ietf.org/html/rfc7231#section-6.5.3)                  | L’appelant de l’API n’a pas accès à cette ressource                                           | Aucun  |
| 429    | [Trop de requêtes](https://tools.ietf.org/html/rfc6585#section-4)              | Trop de requêtes                                                                              | Aucun  |
| 500    | [Erreur interne du serveur](https://tools.ietf.org/html/rfc7231#section-6.6.1) | Erreur interne du serveur                                                                     | Aucun  |

#### Schéma de réponse <a href="#upsert-conversions-responseschema" id="upsert-conversions-responseschema"></a>

### Créer ou mettre à jour des produits <a href="#upsert-products" id="upsert-products"></a>

> 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 point de terminaison crée et met à jour des produits. Votre requête sera traitée de manière asynchrone. Le traitement de la requête et l’application des mises à jour dans la base de données peuvent prendre jusqu’à 24 heures.

> Paramètre du corps

```
{"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 <a href="#upsert-products-parameters" id="upsert-products-parameters"></a>

| Nom           | Dans    | Type                     | Obligatoire | Description                                                 |
| ------------- | ------- | ------------------------ | ----------- | ----------------------------------------------------------- |
| Authorization | en-tête | string                   | true        | Jeton d’autorisation                                        |
| corps         | corps   | [Produit](#tocs_product) | true        | Produits au format JSON délimité par des retours à la ligne |

#### Réponses <a href="#upsert-products-responses" id="upsert-products-responses"></a>

| Statut | Signification                                                              | Description       | Schéma |
| ------ | -------------------------------------------------------------------------- | ----------------- | ------ |
| 202    | [Accepté](https://tools.ietf.org/html/rfc7231#section-6.3.3)               | Accepté           | Aucun  |
| 207    | [Statut multiple](https://tools.ietf.org/html/rfc2518#section-10.2)        | Statut multiple   | Aucun  |
| 401    | [Non autorisé](https://tools.ietf.org/html/rfc7235#section-3.1)            | Non autorisé      | Aucun  |
| 405    | [Méthode non autorisée](https://tools.ietf.org/html/rfc7231#section-6.5.5) | Entrée non valide | Aucun  |

## Schémas <a href="#schemas" id="schemas"></a>

### Conversion <a href="#tocs_conversion" id="tocs_conversion"></a>

```
{
  "id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
  "user": {
    "email": "user@example.com", 
    "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": "user@example.com",
    "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 créer des segments pertinents avec des conditions avancées.

#### Propriétés <a href="#properties" id="properties"></a>

| Nom                       | Type                                      | Obligatoire | Restrictions     | Description                                                                                                                                                                                                                                                                                                                                   |
| ------------------------- | ----------------------------------------- | ----------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                        | string(1-50)                              | true        | none             | ID de conversion. Utilisé comme clé pour les mises à jour                                                                                                                                                                                                                                                                                     |
| utilisateur               | object                                    | true        | none             | Toutes les propriétés que vous ajoutez ici seront utilisées comme conditions pour faire correspondre les utilisateurs de 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 pour l’utilisateur dans l’interface des variables. |
| » user.email              | string(1-250)                             | false       | none             | E-mail de l’utilisateur                                                                                                                                                                                                                                                                                                                       |
| »user.consent\_categories | string                                    | false       | none             | Catégories de consentement de l’utilisateur, requises pour pouvoir partager les conversions avec les partenaires                                                                                                                                                                                                                              |
| type                      | string(1-250)                             | true        | none             | Type de conversion (online, offline, appel, etc.)                                                                                                                                                                                                                                                                                             |
| status                    | string                                    | true        | none             | Statut de votre conversion (voir la liste des valeurs possibles ci-dessous). Les conversions dont le statut est « pending » ne sont pas incluses dans les sommes et les décomptes agrégés par utilisateur par défaut.                                                                                                                         |
| created                   | string(ISO-8601)                          | true        | none             | Date à laquelle la conversion a eu lieu. Consultez la section « Formats de date » ci-dessus pour connaître les formats autorisés.                                                                                                                                                                                                             |
| updated                   | string(ISO-8601)                          | false       | none             | Date de mise à jour de la conversion. Consultez la section « Formats de date » ci-dessus pour connaître les formats autorisés.                                                                                                                                                                                                                |
| acknowledged              | booléen                                   | false       | none             | Définissez cette valeur sur true si la conversion a été confirmée                                                                                                                                                                                                                                                                             |
| currency                  | string(ISO-4217)                          | true        | none             | Devise                                                                                                                                                                                                                                                                                                                                        |
| comment                   | string(1-250)                             | false       | none             | Commentaire de l’acheteur                                                                                                                                                                                                                                                                                                                     |
| billing\_address          | [Adresse](#tocs_address)                  | false       | none             | Il est recommandé d’utiliser autant de champs que possible afin de pouvoir créer des segments pertinents avec des conditions avancées.                                                                                                                                                                                                        |
| contact\_address          | [Adresse](#tocs_address)                  | false       | none             | Il est recommandé d’utiliser autant de champs que possible afin de pouvoir créer des segments pertinents avec des conditions avancées.                                                                                                                                                                                                        |
| shipping\_address         | [Adresse](#tocs_address)                  | false       | none             | Il est recommandé d’utiliser autant de champs que possible afin de pouvoir créer des segments pertinents avec des conditions avancées.                                                                                                                                                                                                        |
| shipping\_provider        | string(1-250)                             | false       | none             | Transporteur                                                                                                                                                                                                                                                                                                                                  |
| shipping\_tracking\_code  | string(1-250)                             | false       | none             | Code de suivi de l’expédition                                                                                                                                                                                                                                                                                                                 |
| payment\_method           | string                                    | false       | none             | Type de moyen de paiement (voir la liste des valeurs possibles ci-dessous)                                                                                                                                                                                                                                                                    |
| payment\_provider         | string                                    | false       | none             | Prestataire de paiement utilisé pour cette transaction                                                                                                                                                                                                                                                                                        |
| original\_quantity        | float                                     | false       | en lecture seule | Somme de tous les articles de la conversion d’origine (CALCULÉE)                                                                                                                                                                                                                                                                              |
| cancelled\_quantity       | float                                     | false       | en lecture seule | Quantité d’articles annulés dans la conversion (CALCULÉE)                                                                                                                                                                                                                                                                                     |
| returned\_quantity        | float                                     | false       | en lecture seule | Quantité d’articles retournés dans la conversion (CALCULÉE)                                                                                                                                                                                                                                                                                   |
| exchanged\_quantity       | float                                     | false       | en lecture seule | Quantité d’articles échangés dans la conversion (CALCULÉE)                                                                                                                                                                                                                                                                                    |
| final\_quantity           | float                                     | false       | en lecture seule | Quantité d’articles dans la transaction finale pour cette conversion (original\_quantity - cancelled\_quantity - returned\_quantity - exchanged\_quantity) (CALCULÉE)                                                                                                                                                                         |
| original\_amount          | float                                     | false       | écriture unique  | Montant initial de cette conversion (frais de livraison et taxes inclus)                                                                                                                                                                                                                                                                      |
| cancelled\_amount         | float                                     | false       | none             | Montant annulé pour cette conversion                                                                                                                                                                                                                                                                                                          |
| returned\_amount          | float                                     | false       | none             | Montant remboursé pour cette conversion                                                                                                                                                                                                                                                                                                       |
| exchanged\_amount         | float                                     | false       | none             | Montant des échanges pour cette conversion                                                                                                                                                                                                                                                                                                    |
| shipping\_amount          | float                                     | false       | none             | Montant des frais de livraison pour cette conversion                                                                                                                                                                                                                                                                                          |
| discount\_amount          | float                                     | false       | none             | Montant de la remise pour cette conversion                                                                                                                                                                                                                                                                                                    |
| tax\_amount               | float                                     | false       | none             | Montant des taxes pour cette conversion                                                                                                                                                                                                                                                                                                       |
| final\_amount             | float                                     | false       | none             | Montant final de cette conversion après retours, échanges, annulations, etc. (frais de livraison et taxes inclus). Il représente le montant total de la transaction entre l’acheteur et le vendeur.                                                                                                                                           |
| custom                    | object                                    | false       | none             | Objet contenant des propriétés personnalisées                                                                                                                                                                                                                                                                                                 |
| conversion\_items         | \[[ConversionItem](#tocs_conversionitem)] | true        | none             | Liste des produits de la conversion et de leurs attributs propres. Un même produit ne peut pas apparaître deux fois dans une conversion, sauf si vous fournissez un ID d’élément de conversion.                                                                                                                                               |

**Valeurs énumérées**

| Propriété       | Valeur                          |
| --------------- | ------------------------------- |
| status          | canceled                        |
| status          | livré                           |
| status          | in\_progress                    |
| status          | partiellement\_livré            |
| status          | partiellement\_retourné         |
| status          | partiellement\_expédié          |
| status          | en\_attente\_d’expédition       |
| status          | retourné                        |
| status          | expédié                         |
| status          | en\_attente                     |
| 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 <a href="#tocs_conversionitem" id="tocs_conversionitem"></a>

```
{
  "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 créer des segments pertinents avec des conditions avancées.

#### Propriétés <a href="#properties" id="properties"></a>

| Nom                 | Type                     | Obligatoire | Restrictions | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ------------------- | ------------------------ | ----------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                  | string                   | true        | none         | ID de cet élément dans la conversion. Cet ID est obligatoire. Si votre base de données ne contient pas d’ID d’élément et que le même ID de produit ne peut pas être répété dans une conversion, vous pouvez utiliser l’ID du produit comme valeur. Ce champ sert à identifier l’élément lors des mises à jour.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| original\_quantity  | float                    | true        | none         | Quantité d’éléments dans la conversion d’origine                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| cancelled\_quantity | float                    | false       | none         | Quantité d’éléments annulés                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| returned\_quantity  | float                    | false       | none         | Quantité d’éléments retournés                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| exchanged\_quantity | float                    | false       | none         | Quantité d’éléments échangés                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| final\_quantity     | float                    | false       | none         | Quantité d’éléments dans la transaction finale (original\_quantity - cancelled\_quantity - returned\_quantity - exchanged\_quantity)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| original\_amount    | float                    | false       | none         | Montant d’origine de cet élément                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| cancelled\_amount   | float                    | false       | none         | Montant annulé pour cet élément                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| returned\_amount    | float                    | false       | none         | Montant retourné pour cet élément                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| exchanged\_amount   | float                    | false       | none         | Montant échangé pour cet élément                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| final\_amount       | float                    | false       | none         | Montant final de cet élément (original\_amount - cancelled\_amount - returned\_amount - exchanged\_amount)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| prix                | float                    | false       | none         | Prix de l’élément (dans la même devise que la conversion)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| original\_item      | booléen                  | false       | none         | Indique si cet élément était présent dans la conversion d’origine. Cette valeur est automatiquement définie sur false pour tous les éléments ajoutés lors des mises à jour de conversion.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| custom              | object                   | false       | none         | Objet contenant des propriétés personnalisées                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| product             | [Produit](#tocs_product) | true        | none         | <p>Il existe trois façons d’inclure des informations sur les produits dans vos éléments de conversion. Première méthode : renseigner les propriétés du produit directement dans chaque élément de conversion. Deuxième méthode : synchroniser votre catalogue de produits avec notre base de données à l’aide du point de terminaison "POST /products/bulk" et n’envoyer que les ID des produits dans les éléments de conversion (notre serveur copiera les propriétés des produits depuis le catalogue). Troisième méthode : combiner les deux méthodes précédentes, c’est-à-dire disposer d’un catalogue de produits et envoyer les informations sur les produits directement. Si une propriété figure à la fois dans le produit du catalogue et dans les informations du produit envoyées directement, ces dernières remplacent celles du catalogue. Cette méthode est utile lorsque les informations sur les produits envoyées directement sont incomplètes ou complémentaires.<br>Il est recommandé d’envoyer les informations sur les produits directement, sauf si vous ne disposez pas de toutes les informations nécessaires. 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 créer des segments pertinents avec des conditions avancées.<br>Lorsque vous envoyez uniquement l’ID du produit dans un élément de conversion, vous devez vous assurer que le produit figure déjà dans votre catalogue ; sinon, les propriétés du produit ne seront pas ajoutées à votre élément de conversion.</p> |

### Adresse <a href="#tocs_address" id="tocs_address"></a>

```
{
  "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 créer des segments pertinents avec des conditions avancées.

#### Propriétés <a href="#properties" id="properties"></a>

| Nom                | Type             | Obligatoire | Restrictions | Description                                                                                                                                                      |
| ------------------ | ---------------- | ----------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| country            | string(1-250)    | false       | none         | Nom du pays en toutes lettres                                                                                                                                    |
| iso\_country\_code | string(ISO-3166) | false       | none         | Code pays ISO-3166                                                                                                                                               |
| country\_code      | string           | false       | none         | Utilisez ce champ si vous utilisez des codes pays autres que ceux de la norme ISO-3166                                                                           |
| region             | string(1-250)    | false       | none         | Région administrative                                                                                                                                            |
| locality           | string(1-250)    | false       | none         | Nom de la ville, du village, etc.                                                                                                                                |
| postal\_code       | string(1-250)    | false       | none         | Code postal                                                                                                                                                      |
| recipient          | string(1-250)    | false       | none         | Nom du destinataire                                                                                                                                              |
| street\_address    | string(1-250)    | false       | none         | Nom de rue, numéro de rue, numéro de bâtiment, etc.                                                                                                              |
| full\_address      | string(1-250)    | false       | none         | Adresse complète sous forme de chaîne pouvant contenir des sauts de ligne. Ne peut pas être utilisée pour la segmentation, mais est disponible pour les exports. |
| label              | string(1-250)    | false       | none         | Libellé de cette adresse (domicile, travail, etc.)                                                                                                               |
| coordinates        | object           | false       | none         | Coordonnées de cette adresse                                                                                                                                     |
| » latitude         | float            | false       | none         | Latitude                                                                                                                                                         |
| » longitude        | float            | false       | none         | Longitude                                                                                                                                                        |

### Produit <a href="#tocs_product" id="tocs_product"></a>

```
{
  "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 existe trois façons d’ajouter des informations sur les produits à vos articles de conversion. La première consiste à renseigner les propriétés du produit directement dans chaque article de conversion. La deuxième consiste à synchroniser votre catalogue de produits avec notre base de données à l’aide du point de terminaison "POST /products/bulk", puis à n’envoyer que les ID des produits dans les articles de conversion (notre serveur copiera les propriétés des produits depuis le catalogue). La troisième combine les deux méthodes précédentes : elle consiste à disposer d’un catalogue de produits et à envoyer les informations sur les produits directement. Si une propriété est présente à la fois dans le produit du catalogue et dans le produit renseigné directement, la valeur renseignée directement remplace celle du catalogue. Cette méthode est utile lorsque les informations sur les produits renseignées directement sont incomplètes ou complémentaires. Il est recommandé d’envoyer les produits directement, sauf si vous ne disposez pas de toutes les informations les concernant. 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 créer des segments pertinents avec des conditions avancées. Lorsque vous n’envoyez que l’ID du produit dans un article de conversion, vous devez vous assurer que le produit figure déjà dans votre catalogue ; sinon, ses propriétés ne seront pas ajoutées à l’article de conversion.

#### Propriétés <a href="#properties" id="properties"></a>

| Nom                | Type                   | Obligatoire | Restrictions | Description                                                                                                                                                                                                                                                                  |
| ------------------ | ---------------------- | ----------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                 | string(1-50)           | true        | none         | Identifiant unique de l’article (essayez d’utiliser l’identifiant ou le SKU le plus précis), par exemple une référence. Si le même identifiant apparaît plusieurs fois, seule la dernière occurrence sera enregistrée.                                                       |
| name               | string(1-500)          | false       | none         | Nom de l’article                                                                                                                                                                                                                                                             |
| description        | string(max 5000 chars) | false       | none         | Description de l’article                                                                                                                                                                                                                                                     |
| category\_1        | string(1-250)          | false       | none         | Catégorie principale de l’article                                                                                                                                                                                                                                            |
| category\_2        | string(1-250)          | false       | none         | Deuxième sous-catégorie de l’article                                                                                                                                                                                                                                         |
| category\_3        | string(1-250)          | false       | none         | Troisième sous-catégorie de l’article                                                                                                                                                                                                                                        |
| category\_4        | string(1-250)          | false       | none         | Quatrième sous-catégorie de l’article                                                                                                                                                                                                                                        |
| category\_5        | string(1-250)          | false       | none         | Cinquième sous-catégorie de l’article. Si votre arborescence comporte plus de cinq niveaux, vous pouvez concaténer les niveaux restants, par exemple « Bikes/Parts/Wheels/Front », ou simplement les ignorer, comme « Bikes », selon vos besoins en matière de segmentation. |
| tags               | \[string]              | false       | none         | Tableau de tags pour le produit. Les tags peuvent désigner n’importe quelle caractéristique du produit : fait main, écologique, résistant à la chaleur, etc.                                                                                                                 |
| condition          | string                 | false       | none         | État actuel de l’article dans votre boutique (consultez la liste des valeurs possibles ci-dessous)                                                                                                                                                                           |
| availability       | string                 | false       | none         | Disponibilité actuelle de l’article dans votre boutique. Veillez à indiquer sa disponibilité sur la page de votre boutique et à la tenir à jour (consultez la liste des valeurs possibles ci-dessous).                                                                       |
| availability\_date | string(ISO-8601)       | false       | none         | Date à laquelle le produit est devenu ou deviendra disponible. Consultez la section « Formats de date » ci-dessus pour connaître les formats autorisés.                                                                                                                      |
| expiration\_date   | string(ISO-8601)       | false       | none         | Date à laquelle le produit est devenu ou deviendra indisponible. Consultez la section « Formats de date » ci-dessus pour connaître les formats autorisés.                                                                                                                    |
| prix               | float                  | false       | none         | Prix par défaut de l’article. Lors d’une conversion, vous pouvez indiquer le prix réel auquel l’article a été vendu, notamment en cas de vente ou de réduction.                                                                                                              |
| sale\_price        | float                  | false       | none         | Prix par défaut de l’article pendant les périodes de soldes. Lors d’une conversion, vous pouvez indiquer le prix réel auquel l’article a été vendu en cas de réduction.                                                                                                      |
| currency           | string(ISO-4217)       | false       | none         | Devise utilisée pour les prix indiqués. Veuillez noter que vous devez utiliser la même devise pour les produits et les conversions.                                                                                                                                          |
| image\_link        | string(url)            | false       | none         | URL de l’image du produit                                                                                                                                                                                                                                                    |
| link               | string(url)            | false       | none         | URL du site web où vous pouvez acheter l’article                                                                                                                                                                                                                             |
| brand              | string(1-250)          | false       | none         | Marque de l’article                                                                                                                                                                                                                                                          |
| width              | float                  | false       | none         | Largeur de l’article en centimètres (cm)                                                                                                                                                                                                                                     |
| length             | float                  | false       | none         | Longueur de l’article en centimètres (cm)                                                                                                                                                                                                                                    |
| height             | float                  | false       | none         | Hauteur de l’article en centimètres (cm)                                                                                                                                                                                                                                     |
| weight             | float                  | false       | none         | Poids de l’article en grammes                                                                                                                                                                                                                                                |
| size               | string(1-250)          | false       | none         | Taille de l’article lorsque la largeur, la hauteur et la longueur ne s’appliquent pas. Vous pouvez utiliser toute valeur décrivant la taille. Exemples : S, XL, grande                                                                                                       |
| colors             | \[string]              | false       | none         | Couleurs du produit                                                                                                                                                                                                                                                          |
| genre              | string(1-250)          | false       | none         | Genre pour les produits genrés (homme, femme, unisexe)                                                                                                                                                                                                                       |
| gtin               | string(1-250)          | false       | none         | Numéro international d’identification commerciale de l’article. Numéros acceptés : UPC (Amérique du Nord, 12 chiffres), EAN (Europe, 13 chiffres), JAN (Japon, de 8 à 13 chiffres), ISBN (livres, 13 chiffres)                                                               |
| mpn                | string(1-250)          | false       | none         | Numéro de référence du fabricant pour le produit                                                                                                                                                                                                                             |
| custom             | object                 | false       | none         | Objet contenant des propriétés personnalisées                                                                                                                                                                                                                                |

**Valeurs énumérées**

| Propriété    | Valeur                 |
| ------------ | ---------------------- |
| condition    | new                    |
| condition    | reconditionné          |
| condition    | occasion               |
| availability | en\_stock              |
| availability | disponible             |
| availability | précommande            |
| availability | en\_rupture\_de\_stock |
| genre        | homme                  |
| genre        | femme                  |
| genre        | unisexe                |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.commandersact.com/fr/fonctionnalites/sources/sources-catalog/import-conversions/api-conversions-and-product-catalog.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
