Products

CM11 - Export Source Product Data Sheet status

Request

Description

Delta export of the source product data sheet status in JSON format.

Define a cron job in your system that periodically calls this API and sets the previous request date as the updated_since query parameter.

Call Frequency

Recommended usage:
- Differential: every 15 minutes

Maximum usage:
- Differential: every 5 minutes
- Full: every 4 hours

Query

updated_sincestring, (date-time)

Export start date. Given date must respect ISO-8601 format and must be URL encoded

updated_tostring, (date-time)

Export end date. Given date must respect ISO-8601 format and must be URL encoded

statusstring

The status of the product : LIVE / NOT_LIVE

Enum:"LIVE""NOT_LIVE"

provider_unique_identifierArray of strings, [ 0 .. 100 ] items, unique

The provider unique identifier of the product

unique_identifierArray of strings, [ 0 .. 100 ] items, unique

The unique identifier of the product with type (structure: "unique_identifier=&UniqueIdentifierType1|UniqueIdentifierID1,UniqueIdentifierType2|UniqueIdentifierID2, ...").

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/mcm/products/sources/status/export?updated_since=2019-08-24T14%3A15%3A22Z&updated_to=2019-08-24T14%3A15%3A22Z&status=LIVE&provider_unique_identifier=string&unique_identifier=string&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Export success

Bodyapplication/json

Array [

errorsArray of objects

The acceptance, synchronization and integration errors on the product

provider_unique_identifierstring

The provider unique identifier

statusstringrequired

The liveness status of the product : LIVE or NOT_LIVE

unique_identifiersArray of objects

The unique identifiers for the product

warningsArray of objects

The errors of the product

]

Response

[
  {
    "errors": [ … ],
    "provider_unique_identifier": "shopSku1",
    "status": "NOT_LIVE",
    "unique_identifiers": [ … ],
    "warnings": [ … ]
  },
  {
    "provider_unique_identifier": "shopSku2",
    "status": "LIVE",
    "warnings": [ … ]
  }
]