POST Create orders
POST /orders
Creates the Orders entity.
Request body
Media type: application/json. Schema: Create_Order.
Specifies the Orders to be created.
Responses
- 200
Created the Orders entity.
Media type:
application/json. Schema:Create_Order_Response.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success", "additionalStatus" : { "atomicTransaction": "Existing", "idValues": ["1135728"] } }, "minimalResults" : [ "1135728"], "detailResults": [ { "id" : "11013482", "advertiserId": "11323", "orderHeader": { "agencies": [ { "id": "AGENCY100" } ], "salespeople": [ { "id": "98878", "email": "rd@gmail.com", "name": "John", "role": "Customer Success Manager", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01" } ], "publisher": { "id": "AGENCY100" }, "revenueSpecs": { "revenueTypecode": "PRORATE" }, "billingSpecs": { "billingCycleType": "Broadcast" }, "purchaseOrderNumber": "01/2023 DEN" } } ], "additionalFields": { "contractId": "additionField1" } } - 400
There was an issue with your request.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 400, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "BAD_REQUEST", "verboseMessage": "Errors: /items/0 required key [startDate] not found." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 401
Authorization failed.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 401, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Unauthorised", "verboseMessage": "Credentials are incorrect." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 403
Request forbidden.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 403, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Forbidden", "verboseMessage": "Request forbidden." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 404
Resource not found.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 404, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "NotFound", "verboseMessage": "Resource not found." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 405
Method not allowed.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 405, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Method Not Allowed", "verboseMessage": "Method not allowed for this resource." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 415
Unsupported media type.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 415, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Unsupported Media Type", "verboseMessage": "Requested media type not supported." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 422
Unprocessable entity.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 422, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Unprocessable Content", "verboseMessage": "Requested content can't be processed." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 500
Unable to complete the request as the server encountered an error.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 500, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Internal Server Error", "verboseMessage": "The server encountered an unexpected condition that prevented it from fulfilling the request." }, "minimalResults": [], "detailResults": [], "additionalFields": [] }