Update Order Address

PATCH 
/orders/:lookupKey/:lookupValue/addresses/:addressId

Use this endpoint to update an order address. The address is identified by id.

Request

Path Parameters

lookupKey stringrequired

Use id or externalId

lookupValue stringrequired

The id or externalId of the order

addressId stringrequired

Address Id

application/json

Body

postalCode string

Responses

200

Update Order Address - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

id number

postalCode string
messages string[]
total number

Example (from schema)

{
  "data": {
    "id": 81902,
    "postalCode": "7323 KE"
  },
  "messages": [
    "Address updated"
  ],
  "total": 1
}

Update Order Address - 200

{
  "data": {
    "id": 81902,
    "postalCode": "7323 KE"
  },
  "messages": [
    "Address updated"
  ],
  "total": 1
}

400

Update Order Address - 400 (invalid schema)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [postalCodes] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Update Order Address - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [postalCodes] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

404

Update Order Address - 404 (order not found) / Update Order Address - 404 (address not found)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 15003,
    "messages": [
      "Parent resource [Order] with id [295] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/15003",
    "status": 404,
    "type": "ParentOrderNotFound"
  }
}

Update Order Address - 404 (address not found)

{
  "error": {
    "code": 90006,
    "messages": [
      "Address with id [819021] not found for [Orders] with id [195]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/90006",
    "status": 404,
    "type": "AddressNotFound"
  }
}

Update Order Address - 404 (order not found)

{
  "error": {
    "code": 15003,
    "messages": [
      "Parent resource [Order] with id [295] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/15003",
    "status": 404,
    "type": "ParentOrderNotFound"
  }
}

Loading...