List category types
The user needs to be logged in to use this endpoint, click here to read more.
Category API for looking up valid categories that can be used on an order.
SecurityAuthorization_Code
Responses
200
OK
Response Schema: application/json
Array of objects |
400
Bad Request
429
Too Many Requests
500
Internal Server Error
get/v1/customer/addressCategory/categoryTypes
Request samples
- curl
Response samples
- 200
- 400
- 500
application/json
{- "categoryTypeList": [
- {
- "categoryType": "Job",
- "description": "A paid position of regular employment.",
- "hasPriority": "Y",
- "maxCodes": 7,
- "useFreeValue": "text"
}
]
}List category codes
The user needs to be logged in to use this endpoint, click here to read more.
SecurityAuthorization_Code
Responses
200
OK
Response Schema: application/json
Array of objects |
400
Bad Request
429
Too Many Requests
500
Internal Server Error
get/v1/customer/addressCategory/categoryCodes
Request samples
- curl
Response samples
- 200
- 400
- 500
application/json
{- "categoryCodeList": [
- {
- "categoryType": "Job",
- "categoryCode": "Software Engineer",
- "description": "Coding expert"
}
]
}List category codes for category type
The user needs to be logged in to use this endpoint, click here to read more.
CategoryType is an optional parameter that limits the response to a specific category type.
SecurityAuthorization_Code
Responses
200
OK
Response Schema: application/json
Array of objects |
400
Bad Request
429
Too Many Requests
500
Internal Server Error
get/v1/customer/addressCategory/categoryCodes/{categoryType}
Request samples
- curl
Response samples
- 200
- 400
- 500
application/json
{- "categoryCodeList": [
- {
- "categoryType": "Job",
- "categoryCode": "Software Engineer",
- "description": "Coding expert"
}
]
}