/api/v1/facilities/{facilityId}/routing/sortation-rules/{ruleId} (PUT)

PUT

/api/v1/facilities/{facilityId}/routing/sortation-rules/{ruleId}

curl --request PUT \
  --url https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/routing/sortation-rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "carrierCode": "example", "laneDestinationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "serviceLevel": null, "postalCodePrefix": null }'

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

ruleId

required

string format: uuid

Request Body^required

object

carrierCode

required

string

laneDestinationId

required

string format: uuid

serviceLevel

string

nullable

postalCodePrefix

string

nullable

object

carrierCode

required

string

laneDestinationId

required

string format: uuid

serviceLevel

string

nullable

postalCodePrefix

string

nullable

object

carrierCode

required

string

laneDestinationId

required

string format: uuid

serviceLevel

string

nullable

postalCodePrefix

string

nullable

Responses

200

OK

object

id

required

string format: uuid

carrierCode

required

string

serviceLevel

required

string

nullable

postalCodePrefix

required

string

nullable

lane

required

object

id

required

string format: uuid

code

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

object

id

required

string format: uuid

carrierCode

required

string

serviceLevel

required

string

nullable

postalCodePrefix

required

string

nullable

lane

required

object

id

required

string format: uuid

code

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "carrierCode": "example",
  "serviceLevel": "example",
  "postalCodePrefix": "example",
  "lane": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "code": "example"
  },
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z"
}

object

id

required

string format: uuid

carrierCode

required

string

serviceLevel

required

string

nullable

postalCodePrefix

required

string

nullable

lane

required

object

id

required

string format: uuid

code

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "carrierCode": "example",
  "serviceLevel": "example",
  "postalCodePrefix": "example",
  "lane": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "code": "example"
  },
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z"
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}