PUT /carriers/{id}.json

PUT /carriers/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

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.

  • 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
PUT /carriers/{id}.json 
curl \
 -X PUT http://api.example.com/v1/carriers/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"carrierType":"australia_post","createdAt":"2024-05-04T09:42:00+00:00","externalId":"string","id":42,"name":"string","platform":"manual","updatedAt":"2024-05-04T09:42:00+00:00"}'
Request example 
{
  "carrierType": "australia_post",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "externalId": "string",
  "id": 42,
  "name": "string",
  "platform": "manual",
  "updatedAt": "2024-05-04T09:42:00+00:00"
}