# Create an outbound shipment (generating a label)

Operation ID: `connectors.fedexCreateShipment`

Create an outbound shipment (generating a label). POSTs to ``/ship/v1/shipments`` and returns the mapped shipment result (label URL / tracking number).

## Public method

`createShipment`

Signature: `connectors.fedex.createClient(config).createShipment(body)`

Return type: `Promise<FedExCreateShipmentResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/fedex/create-shipment`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`FedexCreateShipmentRequest`](../models/FedexCreateShipmentRequest.md) | Yes |  |  |  | No |  |

Request model: [`FedexCreateShipmentRequest`](../models/FedexCreateShipmentRequest.md)

## Request example

```json
{
  "account_number": "+15555550123",
  "city": "Boston",
  "client_id": "example-client_id",
  "client_secret": "example-client-secret",
  "mode": "sandbox",
  "name": "Repl Smoketest",
  "phone": "+15555550123",
  "state": "MA",
  "street_address": "1 Main St",
  "zip": "02110"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`FedexShipment`](../models/FedexShipment.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "label_url": "https://wwwtest.fedex.com/document/v1/cache/retrieve/SH,83e0d9c7e06c46c9794853147992_SHIPPING_P?isLabel=true&autoPrint=f",
  "service_type": "example-service_type",
  "tracking_number": "+15555550123",
  "transaction_id": "example-transaction_id"
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { FedExCreateShipmentRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "account_number": "+15555550123",
  "city": "Boston",
  "client_id": "example-client_id",
  "client_secret": "example-client-secret",
  "mode": "sandbox",
  "name": "Repl Smoketest",
  "phone": "+15555550123",
  "state": "MA",
  "street_address": "1 Main St",
  "zip": "02110"
};

const result = await connectors.fedex.createClient(config).createShipment(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"account_number":"+15555550123","city":"Boston","client_id":"example-client_id","client_secret":"example-client-secret","mode":"sandbox","name":"Repl Smoketest","phone":"+15555550123","state":"MA","street_address":"1 Main St","zip":"02110"}' \
  'https://dev-api-connectors.health.cloud/connectors/fedex/create-shipment'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.