POST /shipping-integrations.json

application/json

Body Required

labelEndpoint string Required

Label endpoint
name string | null

Name
rateEndpoint string Required

Rate endpoint
refundEndpoint string | null

Refund endpoint
trackingEndpoint string | null

Tracking endpoint

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- labelEndpoint string Required
  
  Label endpoint
- name string | null
  
  Name
- rateEndpoint string Required
  
  Rate endpoint
- refundEndpoint string | null
  
  Refund endpoint
- trackingEndpoint string | null
  
  Tracking endpoint
- updatedAt string(date-time)
  
  Updated at

POST /shipping-integrations.json

curl \
 --request POST 'http://api.example.com/v1/shipping-integrations.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"labelEndpoint":"string","name":"string","rateEndpoint":"string","refundEndpoint":"string","trackingEndpoint":"string"}'

Request examples

{
  "labelEndpoint": "string",
  "name": "string",
  "rateEndpoint": "string",
  "refundEndpoint": "string",
  "trackingEndpoint": "string"
}

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "id": 42,
  "labelEndpoint": "string",
  "name": "string",
  "rateEndpoint": "string",
  "refundEndpoint": "string",
  "trackingEndpoint": "string",
  "updatedAt": "2025-05-04T09:42:00Z"
}