{"note":"OpenAPI conversion -- returning structured metadata","name":"royalmail-com-click-and-drop","description":"ChannelShipper & Royal Mail Public API","version":"1.0.0","base_url":"","endpoints":17,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api ChannelShipper & Royal Mail Public API\n@version 1.0.0\n@auth ApiKey Authorization in header\n@endpoints 17\n@toc version(1), orders(8), carriers(1), services(2), manifests(3), returns(2)\n\n@group version\n@endpoint GET /version\n@desc Get API version details.\n@returns(200) Returns details about the API version\n@errors {500: Internal Server Error}\n\n@endgroup\n\n@group orders\n@endpoint GET /orders/{orderIdentifiers}\n@desc Retrieve specific orders\n@required {orderIdentifiers: any # One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100.}\n@returns(200) Return list of specific orders\n@errors {400: Bad Request (Request has missing or invalid parameters and cannot be parsed), 401: Unauthorized, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /orders/{orderIdentifiers}\n@desc Delete orders\n@required {orderIdentifiers: any # One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100.}\n@returns(200) Provides a list of deleted orders references and ids and errors for orders that failed to delete\n@errors {400: Bad Request (Request has missing or invalid parameters and cannot be parsed), 401: Unauthorized, 403: Forbidden (Feature not available), 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /orders/status\n@desc Set order status\n@required {request: map # At least one of 'orderIdentifier' and 'orderReference' is required. Providing both is disallowed to avoid ambiguity.  When the status is set to 'despatchedByOtherCourier', if the optional parameter 'trackingNumber' is provided then the parameters 'despatchDate', 'shippingCarrier' and 'shippingService' are also required. The maximum collection length is 100.}\n@returns(200) Provides a list of orders\n@errors {400: Bad Request (Request has missing or invalid parameters and cannot be parsed), 401: Unauthorized, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /orders/{orderIdentifiers}/full\n@desc Retrieve details of the specific orders\n@required {orderIdentifiers: any # One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100.}\n@returns(200) Return detailed information about the orders\n@errors {400: Bad Request (Request has missing or invalid parameters and cannot be parsed), 401: Unauthorized, 403: Forbidden (Feature not available), 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group carriers\n@endpoint GET /carriers\n@desc Retrieve list of carriers for the account\n@returns(200) Return list of carriers\n@errors {401: Unauthorized, 500: Internal Server Error}\n\n@endgroup\n\n@group services\n@endpoint GET /services\n@desc Retrieve list of available services for the account, optionally filtered by carrier, destination and package\n@optional {destinationCountryCode: any # ISO 3166-1 alpha-3 country code of the shipment destination (e.g. GBR). Must be a recognised ISO 3166-1 alpha-3 code — an unrecognised value returns a 400. Supply it to scope results to a single destination (e.g. before checkout); GBR additionally requires destinationPostcode to be set. Omit it (along with destinationPostcode, packagingFormat and packageWeight) to browse the full, unfiltered service catalogue for discovery. destinationPostcode, packagingFormat and packageWeight require destinationCountryCode to also be supplied — providing any of them without it returns a 400, since the underlying carrier lookup can only be filtered once a destination is known., destinationPostcode: any # Postcode of the shipment destination. Required when destinationCountryCode is GBR — a 400 is returned if it's missing or blank. For any other destination country, postcode-based filtering isn't supported, so this value is ignored even if supplied., packagingFormat: any # Packaging format of the shipment. Requires destinationCountryCode to also be supplied — a 400 is returned otherwise., packageWeight: any # Weight of the package in grams. Requires destinationCountryCode to also be supplied — a 400 is returned otherwise., carrierGuid: any # GUID of a carrier configured on the account, to scope results to that carrier only. An unrecognised carrierGuid returns a 400. If shippingAccountName is also supplied, both must refer to the same shipping account., shippingAccountName: any # Name of a shipping account configured on the account, to scope results to that shipping account only. An unrecognised shippingAccountName returns a 400. If carrierGuid is also supplied, both must refer to the same shipping account.}\n@returns(200) Return list of services grouped by carrier\n@errors {400: Bad Request, 401: Unauthorized, 500: Internal Server Error}\n\n@endgroup\n\n@group orders\n@endpoint GET /orders\n@desc Retrieve pageable list of orders\n@optional {pageSize: any # The number of items to return, startDateTime: any # Date and time lower bound for items filtering, endDateTime: any # Date and time upper bound for items filtering, continuationToken: any # The token for retrieving the next page of items}\n@returns(200) Return pageable list of orders\n@errors {400: Bad Request (Request has missing or invalid parameters and cannot be parsed), 401: Unauthorized, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /orders\n@desc Create orders\n@required {request: map}\n@returns(200) Request Processed Successfully\n@errors {400: Bad Request (Request has missing or invalid parameters and cannot be parsed), 401: Unauthorized, 500: Internal Server Error}\n\n@endpoint GET /orders/full\n@desc Retrieve pageable list of orders with details\n@optional {pageSize: any # The number of items to return, startDateTime: any # Date and time lower bound for items filtering, endDateTime: any # Date and time upper bound for items filtering, continuationToken: any # The token for retrieving the next page of items}\n@returns(200) Return a pageable list of orders with details\n@errors {400: Bad Request (Request has missing or invalid parameters and cannot be parsed), 401: Unauthorized, 403: Forbidden (Feature not available), 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /orders/{orderIdentifiers}/label\n@desc Return a single PDF file with generated label and/or associated document(s)\n@required {orderIdentifiers: any # One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100., documentType: any # Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\". When documentType is set to \"commercialInvoice\" the includeCommercialInvoice parameter applies.}\n@optional {includeReturnsLabel: any # Include returns label. Required when documentType is set to 'postageLabel', includeCN: any # Include CN22/CN23 with label. Optional parameter. If this parameter is used the setting will override the default account behaviour specified in the \"Label format\" setting \"Generate customs declarations with orders\", includeCommercialInvoice: any # Includes the commercial invoice with the label. Only applies when documentType is \"commercialInvoice\".}\n@returns(200) Return the PDF file with labels\n@errors {400: Bad Request (Request has missing or invalid parameters and cannot be parsed), 401: Unauthorized, 403: Forbidden (Feature available for OBA accounts only), 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group manifests\n@endpoint POST /manifests\n@desc Manifest eligible orders\n@optional {request: map}\n@returns(201) The Manifest all eligible orders request was successful, and a manifest has been created. The Printable PDF manifest is available for download.\n@returns(202) The Manifest eligible orders request was successful, and a manifest has been created. However, the printable manifest PDF is not yet available. The printable manifest PDF should be accessible later via the Get Manifest endpoint. If it is not available after a reasonable period, please contact support for assistance.\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden (Feature not available), 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /manifests/retry/{manifestIdentifier}\n@desc Retry manifest\n@required {manifestIdentifier: any # The manifest number returned from the initial ‘Manifest eligible orders’ endpoint call}\n@returns(201) The Retry Manifest request was successful, and a manifest has been created. The printable manifest PDF is available for download.\n@returns(202) The retry request was successfully processed, and a manifest has been created, but the documentation is not yet available. The manifest should be accessible later via the Get Manifest endpoint. If it is not available after a reasonable period, please contact support for assistance.\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden (Feature not available), 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /manifests/{manifestIdentifier}\n@desc Get manifest\n@required {manifestIdentifier: any # The manifest number returned from the initial ‘Manifest eligible orders’ endpoint call}\n@returns(200) The Get Manifest request was successfully processed. The manifest details were retrieved, but the Printable PDF Manifest may or may not be available at this time. Please try the Get Manifest endpoint. If it is not available after a reasonable period, please contact support for assistance.\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden (Feature not available), 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group returns\n@endpoint GET /returns/services\n@desc List available return services\n@returns(200) Lists all available return services for generating return labels\n@errors {401: Unauthorized, 500: Internal Server Error}\n\n@endpoint POST /returns\n@desc Create a return shipment\n@required {body: map # Return creation request}\n@returns(200) Successfully created return shipment\n@errors {400: Bad Request, 401: Unauthorized, 500: Internal Server Error}\n\n@endgroup\n\n@group services\n@endpoint GET /services/olp\n@desc List available Royal Mail OLP shipping services\n@required {country: any # ISO 3166-1 alpha-3 destination country code. Must be a recognised ISO 3166-1 alpha-3 code — an unrecognised value returns a 400.}\n@optional {weight: any # Package weight in grams., postcode: any # Recipient postcode., packageFormat: any # Package format to filter results by. Applied to the results returned by Royal Mail OLP — it isn't sent to Royal Mail OLP itself, which has no equivalent filter on this call.}\n@returns(200) Lists the available Royal Mail OLP shipping services for the given destination\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden (Royal Mail OLP is not configured for this account), 500: Internal Server Error, 503: The Royal Mail OLP service is currently unavailable}\n\n@endgroup\n\n@end\n"}