Get import

GET 
/subscriptions/imports/:import_uuid

Get import

Request

Path Parameters

import_uuid UUIDrequired

The unique identifier of the import.

Responses

200

Success. The import is returned.

application/json

Schema

Schema

data Import
id UUID (string)
The unique identifier.
type SubscriptionImportType (string)required
Possible values: [subscription_import]
attributes ImportAttributesrequired
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.
status stringrequired
Possible values: [pending, started, success, failed]
The status of job.
meta ImportMetarequired
owner stringrequired
The owner of a resource, either store or organization.
timestamps Timestampsrequired
updated_at stringrequired
The date and time a resource was updated.
created_at stringrequired
The date and time a resource was created.
started_at string
The date and time a job is started.
finished_at string
The date and time a job finished.
records objectrequired
uploaded objectrequired
subscription_product integerrequired
subscription_plan integerrequired
subscription_subscriber integerrequired
imported required
subscription_product integerrequired
subscription_plan integerrequired
subscription_subscriber integerrequired

Example (from schema)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "subscription_import",
    "attributes": {
      "external_ref": "abc123",
      "status": "pending"
    },
    "meta": {
      "owner": "store",
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z",
        "started_at": "2017-01-10T11:41:19.244842Z",
        "finished_at": "2017-01-10T11:41:19.244842Z"
      },
      "records": {
        "uploaded": {
          "subscription_product": 50000,
          "subscription_plan": 50000,
          "subscription_subscriber": 50000
        },
        "imported": {
          "subscription_product": 45090,
          "subscription_plan": 45090,
          "subscription_subscriber": 45090
        }
      }
    }
  }
}

400

Bad request. The request failed validation.

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"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

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...