Order Type API (UAS)

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Aug 28, 2017
Version 10Show Document
  • View in full screen mode

Description

The Order Type API retrieves various types of Orders supported by the Unified Ad Server.

For more information about Order Management Services, refer to Order Management Services (UAS)

Supported Operations

Service Name: /ordertypes/

                     

Method PathHTTP Method TypeDescriptionLink to Definition
/ordertypes/{id}GETRetrieve the details of a specific Order Type for the requested IdRetrieve the Details of an Order Type
/ordertypes/GET

Retrieve a list of all Order Types.

In the query, you can also apply supported dimensions, filters and sorting options to retrieve a list with a specific set of details according to your requirements.

Refer to Common Request Query Parameters for more information about using dimensions, filters and sorting, 

Retrieve a List of Order Types

 

Retrieve the Details of an Order Type

Overview

This API enables you to retrieve the details of an Order Type. 

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Sample URL

https://api.pubmatic.com/v1/uas/orderypes/1 

Response

Response Body Parameters

                        

Parameter NameTypeRequiredValidationsDescription
nameStringYes

Name can be a maximum of 64 characters.

Name should be unique for your account.

Name of Order Type 
descriptionStringNo

Description can be a maximum of 1024 characters.

Order type description (if any)

Sample Response JSON

    

{
    "id": 1,
    "name": "Sale",
    "description": "Sale side order"
}

Retrieve a List of Order Types

Overview

This API enables you to retrieve a list of Order Types. 

In the query, you can also apply supported dimensions, filters and sorting options to retrieve a list with a specific set of details according to your requirements.

Refer to Common Request Query Parameters for more information about using dimensions, filters and sorting, 

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Sample URL

https://api.pubmatic.com/v1/uas/ordertypes/

 

Response

Response Body Parameters

                        

Parameter NameTypeRequiredValidationsDescription
nameStringYes

Name can be a maximum of 64 characters.

Name should be unique for your account.

Name of Order Type 
descriptionStringNo

Description can be a maximum of 1024 characters.

Order type description (if any)

Sample Response 

    

It will return a list of all supported Order Types.

Error Codes for Order Type

             

Sr. NoError CodesDescription
1MISSING_OR_INVALID_PARAMETERRequested details for order type with an id that does not exist or is invalid.

 

Unified Ad Server References

Common Request Query Parameters for Web Services

Supported Operations for Filters

HTTP Status Codes

Unified Ad Server Specific Error Codes

 

Version 0.1

Attachments

    Outcomes