---
title: "POST /openapi/{version}/consignments/channels/upsert-outbound-address/"
method: POST
path: "/openapi/{version}/consignments/channels/upsert-outbound-address/"
tags: ["Outbound Bulk Order (B2B)"]
---

# POST /openapi/{version}/consignments/channels/upsert-outbound-address/

`POST /openapi/{version}/consignments/channels/upsert-outbound-address/`

## Request

- Base URL: `https://base_url`
- URL: `https://base_url/openapi/{version}/consignments/channels/upsert-outbound-address/`
- Auth: none declared

This endpoint allows users to create a destination address for an outbound bulk order channel. ### Example `curl` Request:
To create a destination address for an outbound bulk order, use the following `curl` request:

```bash
curl --location '{{url}}/openapi/v2/consignments/channels/upsert-outbound-address/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
  "address_reference_name": "Singapore Distribution Centre",
  "address": {
    "address_line1": "10 ABC Crescent",
    "address_line2": "#06 ABC Techpark",
    "address_line3": "Building XYZ",
    "phone": "+65-12345678",
    "city": "Singapore",
    "state": "Central Region",
    "country": "Singapore",
    "suburb": "Ubi",
    "zipcode": "408564",
    "email": "john.doe@example.com"
  },
  "channel_id": 5,
  "channel_code": "SGCHANNEL001"
}'
```

## Path parameters

- `version` string, required

## Request body

- BulkOrderBrandDestinationAddressOpenAPI
  - `address_reference_name` string
  - `address` BulkOrderAddressOpenAPI
    - `address_line1` string, required: Address line 1
    - `address_line2` string: Address line 2
    - `address_line3` string: Address line 3
    - `email` string
    - `phone` string
    - `city` string, required: City
    - `state` string, required: State
    - `country` string, required: Country
    - `suburb` string: Suburb
    - `zipcode` string, required: Zipcode
  - `channel` BulkOrderChannelOpenAPI, required
    - `id` integer, required: Id for bulk outbound order channel
    - `channel_name` string, required: Channel name for bulk outbound order channel
    - `channel_code` string, required: Channel code for bulk outbound order channel
    - `channel_desc` string, required: Channel Description for bulk outbound order channel
  - `channel_id` integer: Either channel_id or channel_code must be provided. If both are given, channel_id must match the given channel_code.
  - `channel_code` string: Channel Code (Seller defined. We will create a channel if not exists already), note that either channel_id or channel_code must be provided. If both are given, channel_id must match the given channel_code.

## Response `201`

- EnvelopedBulkOrderBrandDestinationID
  - `success` boolean
  - `data` BulkOrderBrandDestinationID, required
    - `destination_address_id` integer, required
  - `message` string, required

## Other responses

- `400`: Bad Request - Invalid input.
- `401`: Unauthorized - Invalid or expired credentials.
- `403`: Forbidden - You do not have permission to access this resource.
- `404`: Not Found - The requested resource does not exist.
- `500`: Internal Server Error - Unexpected error occurred.

---

[API](https://skmtc.dev/golocad/apis/locad-api.md) - [All operations](https://skmtc.dev/golocad/apis/locad-api/llms.txt) - [OpenAPI document](https://skmtc.dev/golocad/apis/locad-api/revisions/428200f33a81?raw)