Skip to navigation
CargoExtra Gateway API Copyaddress

Create User Address

View as Markdown

Creates an address for the authenticated customer.

Required body fields: email, address1, state, country. Optional: company, phone, address2, city, zipCode, default.

Response fields: the created address document.

Possible errors:

  • 400: Invalid address Id - path id is not a valid Mongo ObjectId.
  • 404: Address not found or not authorized - address does not exist or belongs to another customer.
  • 409: Address already exists - duplicate address detected.
  • 400: Default address cannot be deleted - unset/change default first.
  • 400: Missing One or More Required Parameters - required body/query fields were not supplied.
  • 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
  • 403: Access denied - gateway traffic guard/rate policy blocked the request.
  • 429: Too many requests - gateway rate limit exceeded.
  • 500: Unexpected Error - unhandled gateway or downstream service failure.

Request

This endpoint expects an object.
citystringRequired
emailstringRequiredformat: "email"
phonestringRequired
statestringRequired
companystringRequired
countrystringRequired
defaultbooleanRequired
zipCodestringRequired
address1stringRequired
address2stringRequired

Response

Created
key_0integer
key_1string
key_2double
key_3string
key_4boolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error