List all deliveries

GET

catalogs

deliveries

List all deliveries

curl --request GET \
  --url https://api.pixxel.space/v0/catalogs/deliveries \
  --header 'Authorization: <api-key>'

{
  "deliveries": [
    {
      "catalog_id": "47435e2b-d8c4-51ff-9de9-2be3bfc92276",
      "cloud_delivery": {
        "config": "config",
        "path": "/path/subdirectory1"
      },
      "created_at": "2024-05-27T06:50:20.056549Z",
      "created_by": "60795589-8759-4d00-9162-b1537b66fb3e",
      "delivery_id": "47435e2b-d8c4-41ff-9de9-2be3cfc92276",
      "status": "SUCCESS",
      "target_path": "order_1/catalogs.zip",
      "task_id": "7f74a393-236f-4e02-9d22-b11dea4eac8a",
      "updated_at": "2024-05-27T06:50:20.056549Z",
      "updated_by": "b23d9181-4de1-4856-950b-e83b2ac52830"
    }
  ]
}

📚 View developer guide to learn more

Authorizations

Authorization

string

header

required

Query Parameters

delivery_id

string

Delivery ID

catalog_id

string

Catalog ID

task_id

string

Task ID

order_item_id

string

Order Item ID

Response

deliveries

object[]

Show child attributes

deliveries.catalog_id

string

id of the catalog, whose delivery this resource tracks

Example:

"47435e2b-d8c4-51ff-9de9-2be3bfc92276"

deliveries.cloud_delivery

object

cloud delivery configuration for the delivery resource

Show child attributes

deliveries.cloud_delivery.config

string

required

id of the store

Example:

"config"

deliveries.cloud_delivery.path

string

prefix path to which resource should be transferred to

Example:

"/path/subdirectory1"

deliveries.created_at

string

timestamp of the creation of the delivery resource

Example:

"2024-05-27T06:50:20.056549Z"

deliveries.created_by

string

uuid of the user who created the delivery resource

Example:

"60795589-8759-4d00-9162-b1537b66fb3e"

deliveries.delivery_id

string

id of the delivery

Example:

"47435e2b-d8c4-41ff-9de9-2be3cfc92276"

deliveries.status

enum<string>

status of the delivery resource

Available options:

UNSPECIFIED,

CREATED,

FAILED,

IN_PROGRESS,

SUCCESS

Example:

"SUCCESS"

deliveries.target_path

string

target path where the resource is delivered, add the cloud_config path and target_path to get the actual path of the resource

Example:

"order_1/catalogs.zip"

deliveries.task_id

string

id of the task, whose delivery this resource tracks. The task_id is set only for automated deliveries. Manual deliveries would have the task_id set as null.

Example:

"7f74a393-236f-4e02-9d22-b11dea4eac8a"

deliveries.updated_at

string

timestamp of the last update of the delivery resource

Example:

"2024-05-27T06:50:20.056549Z"

deliveries.updated_by

string

uuid of the user who last updated the delivery resource

Example:

"b23d9181-4de1-4856-950b-e83b2ac52830"

Create deliveriesCreate a delivery request which will be fulfilled async, only one of catalog id or order_item should be populated in a single delivery request.

⌘I

List all deliveries

curl --request GET \
  --url https://api.pixxel.space/v0/catalogs/deliveries \
  --header 'Authorization: <api-key>'

{
  "deliveries": [
    {
      "catalog_id": "47435e2b-d8c4-51ff-9de9-2be3bfc92276",
      "cloud_delivery": {
        "config": "config",
        "path": "/path/subdirectory1"
      },
      "created_at": "2024-05-27T06:50:20.056549Z",
      "created_by": "60795589-8759-4d00-9162-b1537b66fb3e",
      "delivery_id": "47435e2b-d8c4-41ff-9de9-2be3cfc92276",
      "status": "SUCCESS",
      "target_path": "order_1/catalogs.zip",
      "task_id": "7f74a393-236f-4e02-9d22-b11dea4eac8a",
      "updated_at": "2024-05-27T06:50:20.056549Z",
      "updated_by": "b23d9181-4de1-4856-950b-e83b2ac52830"
    }
  ]
}

external

Project

AOI

Search

Indices

Visualizations

Blocks

Insights

Assets

Downloads

Workflows

Jobs

Tasks

Bandset

Order

Archives

Report

Stores

Catalog

List all deliveries

Authorizations

Query Parameters

Response