Checkout Order ============== Checkout an order. Prerequisites ^^^^^^^^^^^^^ - Credentials as described in :doc:`/getting-started/authentication` - A customer tenant identifier C# ^^ To checkout an order, send the result from :doc:`/scenarios/ordering-verify` to this endpoint. Request ^^^^^^^ Request Syntax: +---------+-----------------------------------------------------------+---------------------------------------------+ | Method | Request URI | Description | +=========+===========================================================+=============================================+ | POST | *https://api.crayon.com/api/v1/purchaserequest/checkout* | Primary (preferred url) | +---------+-----------------------------------------------------------+---------------------------------------------+ | POST | *https://api.crayon.com/api/v1/assets/checkout* | Legacy (backward compatibility) | +---------+-----------------------------------------------------------+---------------------------------------------+ Both addresses are valid. Request Body: +-------------------+----------------------------------------------+-----------------------------------+ | Name | Type | Description | +===================+==============================================+===================================+ | order | :doc:`/resources/PurchaseRequestOrder` | The order to checkout | +-------------------+----------------------------------------------+-----------------------------------+ Request Headers: The following HTTP request headers are supported +------------------+----------------+-----------------------------------------------------------------+ | Header | Type | Description | +==================+================+=================================================================+ | Authorization | string | Required. The authorization token in the form Bearer . | +------------------+----------------+----------------------------------------------+------------------+ | Accept | string | Specifies the request and response type, "application/json". | +------------------+----------------+----------------------------------------------+------------------+ | Content-Type | string | Specifies the media type of the resource, "application/json". | +------------------+----------------+----------------------------------------------+------------------+ Request Example: :: POST $"https://api.crayon.com/api/v1/purchaserequest/checkout/" Accept: application/json Content-Type: application/json Authorization: Bearer < Token > Request Body: .. literalinclude:: /scenarios/_static/PurchaseRequestOrderCheckoutRequest.json :language: json Response ^^^^^^^^ If successful, this method returns status code 204 with empty body. Response success and error codes: Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Error Codes | Description | +================================+===========================================================================================================================================================================================================================================================================================+ | 204 Ok | The request has succeeded. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 Bad Request | The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn't be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 401 Unauthorized | The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 404 Not Found | The server has not found anything matching the request. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Sample code ^^^^^^^^^^^ :doc:`/code-samples/nce-ordering`