Update storefront proposal

curl --request PATCH \
  --url https://api.interchange.io/api/v2/storefront/proposals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "notes": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.interchange.io/api/v2/storefront/proposals/{id}"

payload = {
    "label": "<string>",
    "notes": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', notes: '<string>', expiresAt: '2023-11-07T05:31:56Z'})
};

fetch('https://api.interchange.io/api/v2/storefront/proposals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 4503599627370496,
  "proposalCode": "PRP-XK4A29",
  "operatorId": "<string>",
  "operatorRef": {
    "domain": "acme.com"
  },
  "label": "<string>",
  "notes": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "proposalId": "<string>",
  "discoverySessionId": "<string>",
  "snapshot": {
    "products": [
      {
        "productId": "prod_123",
        "name": "Premium CTV Inventory - Sports",
        "channel": "ctv",
        "channels": [
          "streaming_audio",
          "podcast"
        ],
        "inventoryType": "run_of_site",
        "formatTypes": [
          "video_hosted"
        ],
        "cpm": 12.5,
        "currency": "USD",
        "expiresAt": "2023-11-07T05:31:56Z",
        "salesAgentId": "<string>",
        "salesAgentName": "<string>",
        "storefrontId": "<string>",
        "storefrontName": "<string>",
        "supportedRoutingTypes": [],
        "description": "<string>",
        "deliveryType": "guaranteed",
        "briefRelevance": "<string>",
        "productCard": {
          "formatId": {
            "agentUrl": "<string>",
            "id": "<string>"
          },
          "manifest": {}
        },
        "productCardDetailed": {
          "formatId": {
            "agentUrl": "<string>",
            "id": "<string>"
          },
          "manifest": {}
        },
        "pricingOptions": [
          {
            "pricingOptionId": "<string>",
            "pricingModel": "<string>",
            "isFixed": true,
            "rate": 123,
            "floorPrice": 123,
            "fixedPrice": 123,
            "currency": "<string>",
            "priceGuidance": {
              "floor": 123,
              "p25": 123,
              "p50": 123,
              "p75": 123,
              "p90": 123
            }
          }
        ],
        "estimatedExposures": 0,
        "forecast": {},
        "bookability": "<string>",
        "publisherProperties": [
          {
            "publisherDomain": "<string>",
            "propertyType": "<string>",
            "name": "<string>",
            "selectionType": "<string>",
            "identifiers": [
              {}
            ]
          }
        ],
        "isSandbox": true,
        "formatOptions": [
          {
            "format_kind": "video_hosted",
            "format_option_id": "<string>",
            "display_name": "<string>",
            "params": {
              "containers": [
                "mp4"
              ],
              "video_codecs": [
                "h264"
              ],
              "audio_codecs": [
                "aac"
              ]
            }
          }
        ]
      }
    ],
    "proposals": [
      {
        "proposalId": "<string>",
        "name": "<string>",
        "allocations": [
          {
            "productId": "<string>",
            "allocationPercentage": 50,
            "pricingOptionId": "<string>",
            "rationale": "<string>",
            "sequence": 0,
            "tags": [
              "<string>"
            ]
          }
        ],
        "description": "<string>",
        "briefAlignment": "<string>",
        "salesAgentId": "<string>",
        "salesAgentName": "<string>",
        "storefrontId": "<string>",
        "storefrontName": "<string>",
        "supportedRoutingTypes": [],
        "expiresAt": "<string>",
        "totalBudgetGuidance": {
          "min": 123,
          "recommended": 123,
          "max": 123,
          "currency": "<string>"
        }
      }
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "firstViewedAt": "2023-11-07T05:31:56Z",
  "lastViewedAt": "2023-11-07T05:31:56Z",
  "redeemedAt": "2023-11-07T05:31:56Z",
  "redeemedInMediaBuyId": "<string>"
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

PATCH

proposals

{id}

Update storefront proposal

curl --request PATCH \
  --url https://api.interchange.io/api/v2/storefront/proposals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "notes": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.interchange.io/api/v2/storefront/proposals/{id}"

payload = {
    "label": "<string>",
    "notes": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', notes: '<string>', expiresAt: '2023-11-07T05:31:56Z'})
};

fetch('https://api.interchange.io/api/v2/storefront/proposals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 4503599627370496,
  "proposalCode": "PRP-XK4A29",
  "operatorId": "<string>",
  "operatorRef": {
    "domain": "acme.com"
  },
  "label": "<string>",
  "notes": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "proposalId": "<string>",
  "discoverySessionId": "<string>",
  "snapshot": {
    "products": [
      {
        "productId": "prod_123",
        "name": "Premium CTV Inventory - Sports",
        "channel": "ctv",
        "channels": [
          "streaming_audio",
          "podcast"
        ],
        "inventoryType": "run_of_site",
        "formatTypes": [
          "video_hosted"
        ],
        "cpm": 12.5,
        "currency": "USD",
        "expiresAt": "2023-11-07T05:31:56Z",
        "salesAgentId": "<string>",
        "salesAgentName": "<string>",
        "storefrontId": "<string>",
        "storefrontName": "<string>",
        "supportedRoutingTypes": [],
        "description": "<string>",
        "deliveryType": "guaranteed",
        "briefRelevance": "<string>",
        "productCard": {
          "formatId": {
            "agentUrl": "<string>",
            "id": "<string>"
          },
          "manifest": {}
        },
        "productCardDetailed": {
          "formatId": {
            "agentUrl": "<string>",
            "id": "<string>"
          },
          "manifest": {}
        },
        "pricingOptions": [
          {
            "pricingOptionId": "<string>",
            "pricingModel": "<string>",
            "isFixed": true,
            "rate": 123,
            "floorPrice": 123,
            "fixedPrice": 123,
            "currency": "<string>",
            "priceGuidance": {
              "floor": 123,
              "p25": 123,
              "p50": 123,
              "p75": 123,
              "p90": 123
            }
          }
        ],
        "estimatedExposures": 0,
        "forecast": {},
        "bookability": "<string>",
        "publisherProperties": [
          {
            "publisherDomain": "<string>",
            "propertyType": "<string>",
            "name": "<string>",
            "selectionType": "<string>",
            "identifiers": [
              {}
            ]
          }
        ],
        "isSandbox": true,
        "formatOptions": [
          {
            "format_kind": "video_hosted",
            "format_option_id": "<string>",
            "display_name": "<string>",
            "params": {
              "containers": [
                "mp4"
              ],
              "video_codecs": [
                "h264"
              ],
              "audio_codecs": [
                "aac"
              ]
            }
          }
        ]
      }
    ],
    "proposals": [
      {
        "proposalId": "<string>",
        "name": "<string>",
        "allocations": [
          {
            "productId": "<string>",
            "allocationPercentage": 50,
            "pricingOptionId": "<string>",
            "rationale": "<string>",
            "sequence": 0,
            "tags": [
              "<string>"
            ]
          }
        ],
        "description": "<string>",
        "briefAlignment": "<string>",
        "salesAgentId": "<string>",
        "salesAgentName": "<string>",
        "storefrontId": "<string>",
        "storefrontName": "<string>",
        "supportedRoutingTypes": [],
        "expiresAt": "<string>",
        "totalBudgetGuidance": {
          "min": 123,
          "recommended": 123,
          "max": 123,
          "currency": "<string>"
        }
      }
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "firstViewedAt": "2023-11-07T05:31:56Z",
  "lastViewedAt": "2023-11-07T05:31:56Z",
  "redeemedAt": "2023-11-07T05:31:56Z",
  "redeemedInMediaBuyId": "<string>"
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

API key or access token

Path Parameters

integer

required

Proposal row id

Required range: 1 <= x <= 9007199254740991

Body

application/json

Request body for editing a storefront proposal

label

string

Updated label

Required string length: 1 - 255

notes

string

Updated notes

Maximum string length: 4000

expiresAt

string<date-time>

Updated expiry (ISO 8601)

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

Update storefront proposal

A persisted storefront proposal

integer

required

Proposal row id

Required range: 1 <= x <= 9007199254740991

proposalCode

string

required

Short shareable handle. Sellers give this to buyers; buyers pass it to discover_products.

Example:

"PRP-XK4A29"

operatorId

string

required

Encoded buyer binding retained for backwards compatibility. Use operatorRef for the structured form.

operatorRef

object

required

Structured buyer binding for redemption auth.

Option 1
Option 2

Show child attributes

label

string

required

notes

string | null

required

status

enum<string>

required

Proposal lifecycle status. 'active': available to redeem. 'redeemed': buyer has applied it to a media buy. 'expired': past TTL. 'revoked': seller withdrew.

Available options:

active,

redeemed,

expired,

revoked

expiresAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

proposalId

string

required

The protocol-level proposalId from the saved discovery snapshot

discoverySessionId

string

required

Discovery session id this proposal was captured from (for traceability)

snapshot

object

required

The frozen products + proposals returned to the buyer on redemption

Show child attributes

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

createdBy

string

required

firstViewedAt

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

lastViewedAt

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

redeemedAt

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

redeemedInMediaBuyId

string | null

required

Get storefront proposal Revoke storefront proposal

⌘I