@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Aftermarket API
@version 1.0.0
@endpoints 3
@toc customers(1), aftermarket(2)

@group customers
@endpoint GET /v1/customers/{customerId}/auctions/listings
@desc Get listings from GoDaddy Auctions
@required {customerId: any # An identifier for a customer.}
@optional {domains: any # Only include results for the specified domains. Use comma-separated string to include more than one domain. For example, `one.com,two.info,three.biz`, listingStatus: any # Only include results for the specified listing status., transferBefore: any # Domain transfer time before this time, ISO 8601, in UTC. Defaults to last day of the previous month if not provided. Applicable only for listings in `FULFILLED` listingStatus., transferAfter: any # Domain transfer time after this time, ISO 8601, in UTC. Defaults to first day of the previous month if not provided. Applicable only for listings in `FULFILLED` listingStatus., limit: any # Maximum number of items to return., offset: any # Number of results to skip for pagination.}
@returns(200) Request was successful
@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 422: Required parameters must be specified in correct format, 429: Too many requests received within interval, 500: Internal server error}

@endgroup

@group aftermarket
@endpoint DELETE /v1/aftermarket/listings
@desc Remove listings from GoDaddy Auction
@required {domains: any # A comma separated list of domain names}
@returns(200) Request was successful
@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 422: Required parameters must be specified in correct format, 429: Too many requests received within interval, 500: Internal server error}

@endpoint POST /v1/aftermarket/listings/expiry
@desc Add expiry listings into GoDaddy Auction
@required {expiryListings: [any] # An array of expiry listings to be loaded}
@returns(200) Request was successful
@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 422: Required parameters must be specified in correct format<br>Too many Listings provided<br>Invalid Losing Registrar Id, 429: Too many requests received within interval, 500: Internal server error}

@endgroup

@end