GET /checks/deliveries

Products or variants with errors and not eligible for delivery.

Headers

  • X-Application-Name string

Query parameters

  • client_id string Required

    Client identifier

Responses

  • 200

    OK

    Hide response attribute Show response attribute object
    • errors array[object]

      Error

      Hide errors attributes Show errors attributes array[object]
      • code string

        Possible error codes:

        • MISSING_DELIVERY - there are no deliveries currently set
        • MISSING_PACKAGE_DELIVERY - there are no deliveries for specific product/variant package size
        • OVERSIZE_ARTICLE - some articles are subject to the maximum delivery dimension restrictions
        • OVERWEIGHT_ARTICLE - some articles are subject to the maximum delivery weight restrictions
      • attribute string

        Inspected attribute

      • value string

        Attribute value

      • msg string

        Error message

      • articles array[string]

        First 100 articles with error

GET /checks/deliveries
curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/checks/deliveries?client_id=yourClientId&client_id=api_token_value \
 -H "X-Application-Name: myApplicationName"
Response examples (200)
{
  "errors": [
    {
      "code": "MISSING_PACKAGE_DELIVERY",
      "attribute": "package_size",
      "value": "smallbox",
      "msg": "There is no delivery for 'smallbox' package size",
      "articles": [
        "1755",
        "1756"
      ]
    }
  ]
}
Response examples (200)
{
  "errors": [
    {
      "code": "MISSING_PACKAGE_DELIVERY",
      "attribute": "package_size",
      "value": "smallbox",
      "msg": "There is no delivery for 'smallbox' package size",
      "articles": [
        "1755",
        "1756"
      ]
    }
  ]
}