List import jobs

GET 
/subscriptions/imports

Retrieves a list of all import jobs.

Request

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.

filter string

Responses

200

Success. A list of import jobs is returned.

application/json

Schema

Schema

data Import[]
Array [
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.
• pending - Commerce has received the request but is currently busy processing other requests.
• started - Commerce has started processing the job.
• success - The job has successfully completed.
• failed - The job has failed.
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
You can track the number of records imported to ensure the completeness, accuracy and integrity of the import. Uploaded shows the number of records ready to be imported into Subscriptions. However, this does not mean they are valid subscription objects, only that they have the correct type and their JSON format is properly formatted. Imported shows the number of records that have been both validated and successfully added to Subscriptions.
uploaded objectrequired
subscription_product integerrequired
The total number of products uploaded.
subscription_plan integerrequired
The total number of plans uploaded.
subscription_subscriber integerrequired
The total number of subscribers uploaded.
subscription_offering integerrequired
The total number of offerings uploaded.
subscription integerrequired
The total number of subscriptions uploaded.
imported required
subscription_product integerrequired
The total number of products imported.
subscription_plan integerrequired
The total number of plans imported.
subscription_subscriber integerrequired
The total number of subscribers imported.
subscription_offering integerrequired
The total number of offerings imported.
subscription integerrequired
The total number of subscriptions imported.
]
links object
anyOf
title

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,
            "subscription_offering": 50000,
            "subscription": 50000
          },
          "imported": {
            "subscription_product": 45090,
            "subscription_plan": 45090,
            "subscription_subscriber": 45090,
            "subscription_offering": 45090,
            "subscription": 45090
          }
        }
      }
    }
  ],
  "links": {}
}

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