Sign in

v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB
Documents

List documents

get/documents

Query parameters

pageinteger

Page number used while paginating the response

limitinteger

Number of items per page (50 maximum).

target_culturestring

Code of the data locale into which attribute's values must be retrieved or pushed If empty, default locale from the account will be used.

document_type_codestring

Specific DocumentType to filter on

medias_includedinteger

Accepted values ar "0" or "1". If "1", assets will be inserted in the response for every documents

media_fields_includedinteger

Accepted values ar "0" or "1". If "1", asset fields & values will be inserted in the response

parent_documentsinteger

Accepted values ar "0" or "1". If "1", parents documents fo the current one will be inserted in the response

target_documentsinteger

Accepted values ar "0" or "1". If "1", target documents fo the current one will be inserted in the response

updated_at_minstring

Accepted datetime format is "Y-m-d H:i:s". For API, dates are UTC formatted and not Europe/Paris formatted. If any, only documents updated after this value will be rendered in the response.

Headers

quable-codesstring

List of codes separated by commas in order to filter on those specific documents. Encoding the codes individually before separating them with commas helps prevent abnormal behaviors that can be caused by the presence of special characters.

quable-completenessesstring

List of completeness codes separated by commas in order to filter on those completenesses

quable-tagsstring

List of tags (aka statuses) codes separated by commas in order to filter on those tags

Response

Success

linksstring[]
countinteger

Example response

{
  "data": [
    {
      "id": 40,
      "code": "t_shirt_blue",
      "type": "document",
      "document_type": "product",
      "active": true,
      "created_at": "2019-01-21 00:45:09",
      "updated_at": "2019-03-12 14:32:00",
      "completeness": [
        {
          "code": {
            "locale": {
              "ratio": 54
            }
          }
        }
      ],
      "links": [
        {
          "rel": "self",
          "href": "https://MYPIM.quable.com/api_1.php/xxx"
        }
      ],
      "variants": [
        {
          "id": 467,
          "code": "EG5657868-23",
          "active": true,
          "links": [
            {
              "rel": "self",
              "href": "https://MYPIM.quable.com/api_1.php/xxx"
            }
          ]
        }
      ],
      "medias": [
        {
          "id": 10,
          "code": "14365241GOR-blue-01",
          "active": true,
          "links": [
            {
              "rel": "self",
              "href": "https://MYPIM.quable.com/api_1.php/xxx"
            }
          ]
        }
      ],
      "parent_documents": [
        {
          "id": 89786,
          "code": "t-shirt-red",
          "type": "document",
          "document_type": "product",
          "active": true,
          "created_at": "2019-04-23 18:56:00",
          "updated_at": "2019-04-23 18:56:00",
          "links": [
            {
              "rel": "self",
              "href": "https://MYPIM.quable.com/api_1.php/xxx"
            }
          ]
        }
      ],
      "target_documents": [
        {
          "id": 89786,
          "code": "t-shirt-red",
          "type": "document",
          "document_type": "product",
          "active": true,
          "created_at": "2019-04-23 18:56:00",
          "updated_at": "2019-04-23 18:56:00",
          "links": [
            {
              "rel": "self",
              "href": "https://MYPIM.quable.com/api_1.php/xxx"
            }
          ]
        }
      ]
    }
  ],
  "included": [
    {
      "values": [
        {
          "label": "Quable"
        }
      ]
    }
  ]
}