{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sitecore CDP REST API",
    "version": "v2.1"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Guests",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List guests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests",
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter guests by email address"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of guests to return (max 100)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Number of records to skip for pagination"
              }
            ]
          },
          "docs": "Retrieves a paginated list of guest profiles from Sitecore CDP. Returns up to 100 guests per request. Use the offset and limit parameters to paginate through results. Supports filtering by email or other identifiers using query parameters."
        },
        {
          "info": {
            "name": "Create a guest",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new guest profile in Sitecore CDP. The guest record stores identity and behavioral data used for personalization and segmentation. An email address or other identifying attributes should be provided to enable identity resolution."
        },
        {
          "info": {
            "name": "Get a guest",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              }
            ]
          },
          "docs": "Retrieves a specific guest profile by its unique reference identifier. Returns the full guest object including all stored personal and behavioral attributes."
        },
        {
          "info": {
            "name": "Update a guest (full)",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Performs a full replacement update of a guest profile. All fields in the guest object are replaced with the values provided in the request body. Fields not included in the request will be cleared."
        },
        {
          "info": {
            "name": "Update a guest (partial)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Performs a partial update of a guest profile. Only the fields provided in the request body are updated; all other fields retain their current values. Use this operation when updating a subset of guest attributes."
        },
        {
          "info": {
            "name": "Delete a guest",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              }
            ]
          },
          "docs": "Permanently and irreversibly deletes a guest profile and all associated data from Sitecore CDP. This operation cannot be undone. All orders, sessions, and data extensions linked to the guest are also removed."
        }
      ]
    },
    {
      "info": {
        "name": "Guest Data Extensions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List guest data extensions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/extensions",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              }
            ]
          },
          "docs": "Retrieves all custom data extensions associated with a guest profile. Data extensions are named sets of key-value pairs that store additional structured information beyond the standard guest attributes."
        },
        {
          "info": {
            "name": "Create a guest data extension",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/extensions",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new named data extension on a guest profile. Each extension is identified by a unique name and contains a set of key-value pairs. Only one data extension of each name is supported per guest."
        },
        {
          "info": {
            "name": "Get a guest data extension",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/extensions/:dataExtensionName",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              },
              {
                "name": "dataExtensionName",
                "value": "",
                "type": "path",
                "description": "The name of the data extension"
              }
            ]
          },
          "docs": "Retrieves a specific named data extension for a guest profile. Returns all key-value pairs stored within the extension."
        },
        {
          "info": {
            "name": "Update a guest data extension (full)",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/extensions/:dataExtensionName",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              },
              {
                "name": "dataExtensionName",
                "value": "",
                "type": "path",
                "description": "The name of the data extension"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Performs a full replacement of a guest data extension. All existing key-value pairs are replaced with those provided in the request body."
        },
        {
          "info": {
            "name": "Update a guest data extension (partial)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/extensions/:dataExtensionName",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              },
              {
                "name": "dataExtensionName",
                "value": "",
                "type": "path",
                "description": "The name of the data extension"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Performs a partial update of a guest data extension. Only the key-value pairs included in the request are updated; existing pairs not mentioned are retained."
        },
        {
          "info": {
            "name": "Delete a guest data extension",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/extensions/:dataExtensionName",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              },
              {
                "name": "dataExtensionName",
                "value": "",
                "type": "path",
                "description": "The name of the data extension"
              }
            ]
          },
          "docs": "Permanently deletes a named data extension from a guest profile. All key-value pairs within the extension are removed."
        }
      ]
    },
    {
      "info": {
        "name": "Orders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List guest orders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/orders",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              }
            ]
          },
          "docs": "Retrieves all orders associated with a guest profile. Returns order summaries including order references, totals, status, and creation dates."
        },
        {
          "info": {
            "name": "Create an order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/orders",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new order record associated with a guest profile. Orders capture purchase transactions and support segmentation and personalization based on purchasing behavior. The referenceId and orderedAt fields are immutable after creation."
        },
        {
          "info": {
            "name": "Get an order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/orders/:orderRef",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              },
              {
                "name": "orderRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the order"
              }
            ]
          },
          "docs": "Retrieves a specific order by its reference identifier. Returns the full order object including all line items, contacts, and data extensions."
        },
        {
          "info": {
            "name": "Update an order",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/orders/:orderRef",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              },
              {
                "name": "orderRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the order"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Performs a full replacement update of an order record. Note that the referenceId and orderedAt fields cannot be changed after the order has been created."
        },
        {
          "info": {
            "name": "Delete an order",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/orders/:orderRef",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              },
              {
                "name": "orderRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the order"
              }
            ]
          },
          "docs": "Permanently deletes an order record and all associated items, contacts, consumers, and data extensions. This operation is irreversible."
        }
      ]
    },
    {
      "info": {
        "name": "Order Items",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List order items",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/orders/:orderRef/items",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              },
              {
                "name": "orderRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the order"
              }
            ]
          },
          "docs": "Retrieves all line items within a specific order. Each item represents a product included in the order with its quantity and pricing."
        },
        {
          "info": {
            "name": "Create an order item",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/:guestRef/orders/:orderRef/items",
            "params": [
              {
                "name": "guestRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the guest profile"
              },
              {
                "name": "orderRef",
                "value": "",
                "type": "path",
                "description": "The unique reference identifier for the order"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a new line item to an existing order. Each item references a product and includes quantity and pricing information."
        }
      ]
    }
  ],
  "bundled": true
}