POST /carriers.json

POST /carriers.json
application/json

Body Required

  • carrierType string | null

    Carrier type

    Values are australia_post, canada_post, deutsche_post, dhl_germany, dhl_ecommerce, dhl_express, fedex, gls_fr, lasership, mondial_relay, newgistics, ontrac, purolator, ups, or usps.

  • externalId string | null

    External

  • name string | null

    Name

  • platform string | null Required

    Platform

    Values are shippo or manual. Default value is manual.

Responses

  • • 200

    Successful response

    Hide response attributes Show response attributes object
    • carrierType string | null

      Carrier type

      Values are australia_post, canada_post, deutsche_post, dhl_germany, dhl_ecommerce, dhl_express, fedex, gls_fr, lasership, mondial_relay, newgistics, ontrac, purolator, ups, or usps.

    • createdAt string(date-time)

      Created at

    • externalId string | null

      External

    • id integer(int32)

      Id

    • name string | null

      Name

    • platform string | null Required

      Platform

      Values are shippo or manual. Default value is manual.

    • updatedAt string(date-time)

      Updated at
POST /carriers.json 
curl \
 -X POST http://api.example.com/v1/carriers.json \
 -H "Content-Type: application/json" \
 -d '{"carrierType":"australia_post","externalId":"string","name":"string","platform":"manual"}'
Request example 
{
  "carrierType": "australia_post",
  "externalId": "string",
  "name": "string",
  "platform": "manual"
}
Response examples (200) 
{
  "carrierType": "australia_post",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "externalId": "string",
  "id": 42,
  "name": "string",
  "platform": "manual",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}