v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Shipping::Profile

Create Profile

Add a new shipping profile to a workspace

post/workspaces/{workspace_id}/shipping/profiles

Path parameters

workspace_idinteger required

Request body

Example request

{
  "shipping_profile": {
    "shipping_profile": {
      "name": "Example Shipping Profile",
      "variant_ids": []
    }
  }
}

Response

Created

idinteger

Profile ID

public_idstring nullable

Profile public ID

namestring

Name

{"stackTrail":"components:schemas:ShippingProfileAttributes:properties:variant_ids","oasType":"schema","type":"unknown","description":"Variant IDs"}

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

{
  "id": 2,
  "public_id": "XGHEUg",
  "name": "Example Shipping Profile",
  "variant_ids": [],
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}