GOgolocad
Outbound Bulk Order (B2B)

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

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:

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"
}'

Request

  • Base URL
    https://base_url
  • Auth
    none declared

Path parameters

versionstring required

Request body

address_reference_namestring
channel_idinteger

Either channel_id or channel_code must be provided. If both are given, channel_id must match the given channel_code.

channel_codestring

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

successboolean
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.