click_and_drop_api.ManifestsApi

All URIs are relative to http://api.parcel.royalmail.com/api/v1

Method	HTTP request	Description
get_manifest_async	GET /manifests/{manifestIdentifier}	Get manifest
manifest_eligible_async	POST /manifests	Manifest eligible orders
retry_manifest_async	POST /manifests/retry/{manifestIdentifier}	Retry manifest

get_manifest_async

ManifestDetailsResponse get_manifest_async(manifest_identifier)

Get manifest

Retrieve manifest paperwork for a previously successful ‘Manifest eligible orders’ endpoint call

Example

Api Key Authentication (Bearer):

import click_and_drop_api
from click_and_drop_api.models.manifest_details_response import ManifestDetailsResponse
from click_and_drop_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://api.parcel.royalmail.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = click_and_drop_api.Configuration(
    host = "http://api.parcel.royalmail.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with click_and_drop_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = click_and_drop_api.ManifestsApi(api_client)
    manifest_identifier = 56 # int | The manifest number returned from the initial ‘Manifest eligible orders’ endpoint call. E.g. 12345

    try:
        # Get manifest
        api_response = api_instance.get_manifest_async(manifest_identifier)
        print("The response of ManifestsApi->get_manifest_async:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ManifestsApi->get_manifest_async: %s\n" % e)

Parameters

Name	Type	Description	Notes
manifest_identifier	int	The manifest number returned from the initial ‘Manifest eligible orders’ endpoint call. E.g. 12345

Return type

ManifestDetailsResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
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 <a href='https://help.parcel.royalmail.com/hc/en-gb/articles/115003806094-Contact-Support' target='_self'>contact support</a> for assistance.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden (Feature not available)	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

manifest_eligible_async

ManifestOrdersResponse manifest_eligible_async(request=request)

Manifest eligible orders

Manifest all orders in 'Label Generated' and 'Despatched' statuses and return manifest paperwork where possible.

Example

Api Key Authentication (Bearer):

import click_and_drop_api
from click_and_drop_api.models.manifest_eligible_orders_request import ManifestEligibleOrdersRequest
from click_and_drop_api.models.manifest_orders_response import ManifestOrdersResponse
from click_and_drop_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://api.parcel.royalmail.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = click_and_drop_api.Configuration(
    host = "http://api.parcel.royalmail.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with click_and_drop_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = click_and_drop_api.ManifestsApi(api_client)
    request = click_and_drop_api.ManifestEligibleOrdersRequest() # ManifestEligibleOrdersRequest |  (optional)

    try:
        # Manifest eligible orders
        api_response = api_instance.manifest_eligible_async(request=request)
        print("The response of ManifestsApi->manifest_eligible_async:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ManifestsApi->manifest_eligible_async: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	ManifestEligibleOrdersRequest		[optional]

Return type

ManifestOrdersResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	The Manifest all eligible orders request was successful, and a manifest has been created. The Printable PDF manifest is available for download.	-
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 <a href='https://help.parcel.royalmail.com/hc/en-gb/articles/115003806094-Contact-Support' target='_self'>contact support</a> for assistance.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden (Feature not available)	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retry_manifest_async

ManifestOrdersResponse retry_manifest_async(manifest_identifier)

Retry manifest

Retry a manifest operation if the eligible orders were not able to be successfully processed in the initial ‘Manifest eligible orders’ endpoint call and return manifest paperwork where possible

Example

Api Key Authentication (Bearer):

import click_and_drop_api
from click_and_drop_api.models.manifest_orders_response import ManifestOrdersResponse
from click_and_drop_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://api.parcel.royalmail.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = click_and_drop_api.Configuration(
    host = "http://api.parcel.royalmail.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with click_and_drop_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = click_and_drop_api.ManifestsApi(api_client)
    manifest_identifier = 56 # int | The manifest number returned from the initial ‘Manifest eligible orders’ endpoint call. E.g. 12345

    try:
        # Retry manifest
        api_response = api_instance.retry_manifest_async(manifest_identifier)
        print("The response of ManifestsApi->retry_manifest_async:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ManifestsApi->retry_manifest_async: %s\n" % e)

Parameters

Name	Type	Description	Notes
manifest_identifier	int	The manifest number returned from the initial ‘Manifest eligible orders’ endpoint call. E.g. 12345

Return type

ManifestOrdersResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	The Retry Manifest request was successful, and a manifest has been created. The printable manifest PDF is available for download.	-
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 <a href='https://help.parcel.royalmail.com/hc/en-gb/articles/115003806094-Contact-Support' target='_self'>contact support</a> for assistance.	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden (Feature not available)	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]