Cancel Scheduled Purchase Request by ObjectReferenceId and OrderingNumber¶
Returns a Http Status Code 200 (Success)
Prerequisites¶
Credentials as described in Authentication
Request¶
Request Syntax:
Method |
Request URI |
|---|---|
PUT |
https://api.crayon.com/api/v1/scheduledpurchaserequest/cancel-order/{objectReferenceId}/{orderingNumber} |
Request Headers:
The following HTTP request headers are supported
Header |
Type |
Description |
|
|---|---|---|---|
Authorization |
string |
Required. The authorization token in the form Bearer <token>. |
|
Accept |
string |
Specifies the request and response type, “application/json”. |
|
Content-Type |
string |
Specifies the media type of the resource, “application/json”. |
|
Request Example:
GET $"https://api.crayon.com/api/v1/scheduledpurchaserequest/cancel-order/{objectReferenceId}/{orderingNumber}"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >
Response¶
If successful, this method returns Http Status Code 200 (Success).
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 |
|---|---|
200 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. |