---
title: "Create deliveries"
method: POST
path: "/v0/catalogs/deliveries"
tags: ["Catalog"]
---

# Create deliveries

`POST /v0/catalogs/deliveries`

## Request

- Base URL: `https://api.pixxel.space`
- URL: `https://api.pixxel.space/v0/catalogs/deliveries`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/pixxel/apis/stargate/docs/v0/catalogs/deliveries/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Request body

- ClerkCreateDeliveryRequest
  - `deliveries` ClerkDeliveryRequest[], required
    - `catalog_ids` string[], required: do not supply order_item_ids if this field is used
    - `cloud_info` ClerkCloudDelivery, required
      - `config` string, required: id of the store
      - `path` string: prefix path to which resource should be transferred to
    - `order_item_ids` string[], required: do not supply catalog_ids if this field is used

## Response `201`

Created

- ClerkListDeliveries
  - `deliveries` ClerkDelivery[]
    - `catalog_id` string: id of the catalog, whose delivery this resource tracks
    - `cloud_delivery` ClerkCloudDelivery
      - `config` string, required: id of the store
      - `path` string: prefix path to which resource should be transferred to
    - `created_at` string: timestamp of the creation of the delivery resource
    - `created_by` string: uuid of the user who created the delivery resource
    - `delivery_id` string: id of the delivery
    - `status` 'UNSPECIFIED' | 'CREATED' | 'FAILED' | 'IN_PROGRESS' | 'SUCCESS'
    - `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
    - `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.
    - `updated_at` string: timestamp of the last update of the delivery resource
    - `updated_by` string: uuid of the user who last updated the delivery resource

## Other responses

- `400`: Bad Request
- `409`: Conflict
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pixxel/apis/stargate.md) - [All operations](https://skmtc.dev/pixxel/apis/stargate/llms.txt) - [OpenAPI document](https://skmtc.dev/pixxel/apis/stargate/revisions/519562bd9d7a?raw)