POST
/
shipping
/
create
curl --request POST \
  --url https://api.buybase.ai/shipping/create \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "shipping_address": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "address_1": "<string>",
    "address_2": "<string>",
    "city": "<string>",
    "country_code": "<string>",
    "province_code": "<string>",
    "postal_code": "<string>"
  },
  "profile_id": "<string>"
}'
{
  "success": true,
  "shipping": {
    "id": "ship_12345",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "New York",
    "country_code": "US",
    "province_code": "NY",
    "postal_code": "10001",
    "profile_id": "prof_67890",
    "created_at": "2023-09-15T14:22:31Z"
  },
  "attached_profile_id": "prof_67890",
  "code": "SHIPPING_CREATED"
}

​
Headers

​
authorization
string
required

Your API key for authorization.

​
Body Parameters

​
shipping_address
object
required
​
profile_id
string
required

The ID of the profile to attach this shipping address to.

​
Response

​
success
boolean

Indicates whether the operation was successful.

​
shipping
object

The created shipping address object.

​
attached_profile_id
string

The ID of the profile this shipping address is attached to.

​
code
string

A code indicating the result of the operation. Possible values:

  • SHIPPING_CREATED: Shipping address created successfully
  • SHIPPING_CREATION_FAILED: Failed to create shipping address
​
error
string

Error message if the request fails.

Shipping addresses are used for order fulfillment. Ensure all required fields are provided with accurate information.

{
  "success": true,
  "shipping": {
    "id": "ship_12345",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "New York",
    "country_code": "US",
    "province_code": "NY",
    "postal_code": "10001",
    "profile_id": "prof_67890",
    "created_at": "2023-09-15T14:22:31Z"
  },
  "attached_profile_id": "prof_67890",
  "code": "SHIPPING_CREATED"
}