Get import errors

GET 
/subscriptions/imports/:import_uuid/errors

Retrieves all errors encountered as part of the import. Each error is attributed to a line in the JSONL file imported, so for example, if at line 1 in your JSONL you had a subscription_product without a name, there would be a minimum string error for the name attribute with "line_number": 1.

Errors are also ordered by line number ascending, and can be paginated.

Request

Path Parameters

import_uuid UUIDrequired

The unique identifier of the import.

Query Parameters

page[offset] int64

Possible values: <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

page[limit] int64

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

Responses

200

Success. The import errors are returned.

application/json

Schema

Schema

data object[]
Array [
id UUID (string)required
The unique identifier.
type SubscriptionImportErrorType (string)required
Possible values: [subscription_import_error]
meta objectrequired
owner stringrequired
timestamps Timestampsrequired
updated_at stringrequired
The date and time a resource was updated.
created_at stringrequired
The date and time a resource was created.
error stringrequired
field stringrequired
line_number integerrequired
The line in the imported JSONL file at which the validation error occurred. Starts from 1.
external_ref ExternalRef (string)
Possible values: <= 2048 characters
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
]
links object
anyOf
title

Example (from schema)

{
  "data": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "type": "subscription_import_error",
      "meta": {
        "owner": "store",
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244842Z",
          "created_at": "2017-01-10T11:41:19.244842Z"
        },
        "error": "product name cannot be empty",
        "field": "name",
        "line_number": 123,
        "external_ref": "abc123"
      }
    }
  ],
  "links": {}
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "No plan found"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Loading...