1 pre-requisites
2 Overview
3 Endpoint
- 3.1 Example Request
- 3.2 Example Response
- 3.3 Header Specifications
- 3.4 Input Specifications
- 3.5 Output Specifications

pre-requisites

Overview

Update an order by its id. Also requires an authorizationId as input.

Endpoint

PATCH https://api.adcellerant.com/order/{id}

Example Request

{
    "externalId": "my external id",
    "authorizationId": "123e4567-e89b-42d3-a456-556642440000"
}

Example Response

Status: 200 OK

{
    "id": 12345,
    "externalId": "my external id",
    "status": "SOLD",
    "advertiserId": "12345",
    "advertiserName": "Mr. Advertiser",
    "divisionName": "Mrs. Division",
    "ownerEmail": "email@gmail.com",
    "name": "Advertiser Order 1",
    "updated": "2023-10-19T19:50:49.95Z",
    "orderDetails": [
        {
            "id": 12345,
            "status": "NEW",
            "name": "Email Stuff",
            "budget": 0.0,
            "productKey": null,
            "startDate": "2023-09-01",
            "endDate": "2023-09-30",
            "productId": 12345,
            "activeRateId": 12345,
            "rates": [
                {
                    "id": 12345,
                    "description": null,
                    "billingType": "CPM",
                    "retailAmount": 15.0,
                    "wholesaleAmount": 6.0,
                    "monthlyBudgetMinimum": 0.0,
                    "monthlyImpressionMinimum": 40000.0,
                    "flightMinimum": 0.0
                }
            ],
            "allocations": [
                {
                    "dateRange": {
                        "start": "2023-09-01",
                        "end": "2023-09-30"
                    },
                    "goalSubtype": "NONE",
                    "retailBudget": 600.0,
                    "goalAmounts": {
                        "adSpend": null,
                        "clicks": null,
                        "impressions": 40000.0,
                        "views": null
                    }
                }
            ]
        }
    ]
}

Header Specifications

header	value

header	value
Authorization	Basic <your encoded value>

See: Authentication

Input Specifications

Field	Description

Field	Description
id (path variable)	the id of the order to update
authorizationId	The id that authorizes access to specific orders
externalId	A UID that pertains to an external provider.

Output Specifications

The order object is returned
- See: Order Response

AdCellerant API

Update Order

pre-requisites

Overview

Endpoint

Example Request

Example Response

Header Specifications

Input Specifications

Output Specifications

Related content