@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api spec
@base https://api.ote-godaddy.com
@endpoints 2
@toc orders(2)

@endpoint GET /v1/orders
@desc Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time
@required {X-App-Key: any # A unique application key identifying the source of the request. This is required for request tracking}
@optional {periodStart: any # Start of range indicating what time-frame should be returned. Inclusive, periodEnd: any # End of range indicating what time-frame should be returned. Inclusive, domain: any # Domain name to use as the filter of results, productGroupId: any # Product group id to use as the filter of results, paymentProfileId: any # Payment profile id to use as the filter of results, parentOrderId: any # Parent order id to use as the filter of results, offset: any # Number of results to skip for pagination, limit: any # Maximum number of items to return, sort: any # Property name that will be used to sort results. '-' indicates descending, X-Shopper-Id: any # Shopper ID to be operated on, if different from JWT<br/><b>Reseller subaccounts are not supported</b>}
@returns(200) Request was successful
@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 429: Too many requests received within interval, 500: Internal server error, 504: Gateway timeout}

@endpoint GET /v1/orders/{orderId}
@desc Retrieve details for specified order
@required {orderId: any # Order id whose details are to be retrieved, X-App-Key: any # A unique application key identifying the source of the request. This is required for request tracking}
@optional {X-Shopper-Id: any # Shopper ID to be operated on, if different from JWT<br/><b>Reseller subaccounts are not supported</b>, X-Market-Id: any # Unique identifier of the Market in which the request is happening}
@returns(200) Request was successful
@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Resource not found, 429: Too many requests received within interval, 500: Internal server error, 504: Gateway timeout}

@end
