v2

latestOpenAPI 3.0.32026-08-05174296703.4 KB

ops

getAllOps offer

Fetch all the offers with filters on status and seller

get/ops/offers/all

Query parameters

seller_idstring regexp

Seller ID

Example:739b63c2-9e58-4964-b38d-4ebb424de242

Seller ID

statusstring[]

Offer status

[
  "voided"
]

seller_offer_referencestring

Partner's own reference for this offer

Example:abc123

Partner's own reference for this offer

pending_serial_numbersboolean

Accepted offer that serial number has been pending

end_customer_idstring

Id of the end customer

Example:abc123

Id of the end customer

Response

OK response.

created_atstring date-time required

declined_atstring date-time

expires_atstring date-time required

idstring regexp required

Offer ID

offer_confirmed_atstring date-time

phone_numberstring

Phone number

sales_channel'telesales' | 'ecommerce' required

seller_offer_referencestring required

Partner's own reference for this offer

set_to_pending_review_atstring date-time

sourcestring

Source

total_assetsinteger required

amount of assets in the offer: sum(lines.quantity)

Example response

[
  {
    "agent": {
      "email": "alice@example.com",
      "external_agent_id": "abc123",
      "name": "abc123",
      "phone": "abc123"
    },
    "created_at": "1970-01-01T00:00:01Z",
    "customer": {
      "company": {
        "billing_address": {
          "city": "abc123",
          "country_code": "DE",
          "line1": "abc123",
          "line2": "aaa",
          "postal_code": "abc123",
          "region": "abc123"
        },
        "name": "abc123",
        "tax_number": "abc123",
        "type": "Partnership",
        "vat_number": "DE123456789"
      },
      "email": "alice@example.com",
      "end_customer_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "full_name": "abc123",
      "id": "739b63c2-9e58-4964-b38d-4ebb424de242"
    },
    "declined_at": "1970-01-01T00:00:01Z",
    "expires_at": "1970-01-01T00:00:01Z",
    "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
    "offer_confirmed_at": "1970-01-01T00:00:01Z",
    "order_info": {
      "created_at": "1970-01-01T00:00:01Z",
      "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "status": "confirmed"
    },
    "phone_number": "abc123",
    "sales_channel": "ecommerce",
    "seller_info": {
      "address": {
        "city": "abc123",
        "country_code": "DE",
        "line1": "abc123",
        "line2": "aaa",
        "postal_code": "abc123",
        "region": "abc123"
      },
      "capability_add_custom_products": false,
      "capability_anonymized_pricing": false,
      "capability_anonymous_ecom_offer_creation": false,
      "capability_bundles": false,
      "capability_chatbot_id": "abc123",
      "capability_dual_pricing": false,
      "capability_hide_buy_now": false,
      "capability_international_shipment": false,
      "currency": "abc123",
      "email": "abc123",
      "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "logo_url": "abc123",
      "name": "abc123",
      "parent_seller_id": "abc123",
      "pdf_reader_assistant_id": "abc123",
      "pretty_name": "abc123",
      "product_reference_source": "abc123"
    },
    "seller_offer_reference": "abc123",
    "set_to_pending_review_at": "1970-01-01T00:00:01Z",
    "shipping_address": {
      "city": "abc123",
      "country_code": "DE",
      "line1": "abc123",
      "line2": "aaa",
      "postal_code": "abc123",
      "recipient_name": "abc123",
      "region": "abc123"
    },
    "source": "abc123",
    "status": "voided",
    "total_assets": 1,
    "total_value": {
      "currency": "EUR",
      "gross": 119000,
      "net": 100000
    },
    "user": {
      "email": "abc123",
      "name": "abc123"
    }
  }
]