Sign in

v2

latestOpenAPI 3.0.32026-08-05174296703.4 KB
offer

updateShippingAddress offer

Update an offer's shipping address

put/offers/{id}/update-shipping-address

Path parameters

idstring regexp required

Offer ID

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

Offer ID

Request body

citystring required

City

country_codestring required

ISO 3166-1 alpha-2

line1string required

First line (street, number, etc.)

line2string

Second line (flat number, etc.)

postal_codestring required

Postal code

recipient_namestring

Full name of the recipient

regionstring

Region, county, province, etc.

Example request

{
  "city": "abc123",
  "country_code": "DE",
  "line1": "abc123",
  "line2": "aaa",
  "postal_code": "abc123",
  "recipient_name": "abc123",
  "region": "abc123"
}

Response

OK response.

allowed_billing_countriesstring[] required

List of allowed billing country codes for this offer (derived from the contractual entity)

contractual_entitystring required

The contractual entity that will fulfil this offer

created_atstring date-time required
declined_atstring date-time
exit_redirectstring

URL to redirect to on error

expires_atstring date-time required
has_single_term_durationboolean required

Whether all rental line items must share a single term duration (derived from the contractual entity)

idstring regexp required

Offer ID

offer_confirmed_atstring date-time
offer_linkstring
payment_method_requiredboolean required

Whether the checkout must collect a payment method (derived from the offer's contractual entity server-side)

phone_numberstring

Phone number

redirect_to_superseding_offer_urlstring

link to the top-most offer in the superseding chain

sales_channel'telesales' | 'ecommerce' required
seller_offer_referencestring required

Partner's own reference for this offer

status'created' | 'voided' | 'accepted' | 'expired' | 'rejected' | 'pending_review' | 'declined' required
success_redirectstring

URL to redirect to on success

superseded_by_idstring regexp

ID of the offer that superseded this one (when voided)

updated_atstring date-time

Example response

{
  "agent": {
    "email": "alice@example.com",
    "external_agent_id": "abc123",
    "name": "abc123",
    "phone": "abc123"
  },
  "allowed_billing_countries": [
    "abc123"
  ],
  "contractual_entity": "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",
  "exit_redirect": "abc123",
  "expires_at": "1970-01-01T00:00:01Z",
  "has_single_term_duration": false,
  "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "lines": [
    {
      "applied_discount_id": "abc123",
      "available_contract_terms": {
        "pay_now": {
          "amount": {
            "currency": "EUR",
            "gross": 119000,
            "net": 100000
          },
          "id": "739b63c2-9e58-4964-b38d-4ebb424de242"
        },
        "rent": {
          "duration": 6,
          "durations": [
            12
          ],
          "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
          "monthly_amount": {
            "currency": "EUR",
            "gross": 119000,
            "net": 100000
          }
        }
      },
      "available_first_party_services": [
        {
          "additional_values": {
            "accessory_type": "experiment_charger",
            "deductible_price": {
              "currency": "EUR",
              "gross": 119000,
              "net": 100000
            },
            "images": {
              "url1x": "abc123",
              "url2x": "abc123",
              "url3x": "abc123"
            }
          },
          "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
          "monthly_price": {
            "currency": "EUR",
            "gross": 119000,
            "net": 100000
          },
          "type": "topi_replace"
        }
      ],
      "base_rental_price": {
        "currency": "EUR",
        "gross": 119000,
        "net": 100000
      },
      "contract_terms_list": [
        {
          "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
          "payload": {
            "amount": {
              "currency": "EUR",
              "gross": 119000,
              "net": 100000
            },
            "duration": 6
          },
          "type": "rent"
        }
      ],
      "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "pretty_id": "abc123",
      "price": {
        "currency": "EUR",
        "gross": 119000,
        "net": 100000
      },
      "pricing_category": "legacy_phone_24",
      "product_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "quantity": 1,
      "requires_serial_number": false,
      "selected_contract_terms_id": "abc123",
      "selected_first_party_service_ids": [
        "abc123"
      ],
      "seller_product_provided_by": "abc123",
      "seller_product_references": [
        {
          "reference": "123ab-5343",
          "source": "sap"
        }
      ],
      "seller_product_type": "software",
      "sublines": [
        {
          "applied_discount_id": "abc123",
          "available_contract_terms": {
            "pay_now": {
              "amount": {
                "currency": "EUR",
                "gross": 119000,
                "net": 100000
              },
              "id": "739b63c2-9e58-4964-b38d-4ebb424de242"
            },
            "rent": {
              "duration": 6,
              "durations": [
                12
              ],
              "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
              "monthly_amount": {
                "currency": "EUR",
                "gross": 119000,
                "net": 100000
              }
            }
          },
          "available_first_party_services": [
            {
              "additional_values": {
                "accessory_type": "experiment_charger",
                "deductible_price": {
                  "currency": "EUR",
                  "gross": 119000,
                  "net": 100000
                },
                "images": {
                  "url1x": "abc123",
                  "url2x": "abc123",
                  "url3x": "abc123"
                }
              },
              "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
              "monthly_price": {
                "currency": "EUR",
                "gross": 119000,
                "net": 100000
              },
              "type": "topi_replace"
            }
          ],
          "base_rental_price": {
            "currency": "EUR",
            "gross": 119000,
            "net": 100000
          },
          "contract_terms_list": [
            {
              "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
              "payload": {
                "amount": {
                  "currency": "EUR",
                  "gross": 119000,
                  "net": 100000
                },
                "duration": 6
              },
              "type": "rent"
            }
          ],
          "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
          "pretty_id": "abc123",
          "price": {
            "currency": "EUR",
            "gross": 119000,
            "net": 100000
          },
          "pricing_category": "legacy_phone_24",
          "product_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
          "quantity": 1,
          "requires_serial_number": false,
          "selected_contract_terms_id": "abc123",
          "selected_first_party_service_ids": [
            "abc123"
          ],
          "seller_product_provided_by": "abc123",
          "seller_product_references": [
            {
              "reference": "123ab-5343",
              "source": "sap"
            }
          ],
          "seller_product_type": "software",
          "subtitle": "abc123",
          "title": "abc123"
        }
      ],
      "subtitle": "abc123",
      "title": "abc123"
    }
  ],
  "offer_confirmed_at": "1970-01-01T00:00:01Z",
  "offer_link": "abc123",
  "payment_method_required": false,
  "phone_number": "abc123",
  "pricing_overview": {
    "instead_of_amount": {
      "currency": "EUR",
      "gross": 119000,
      "net": 100000
    },
    "items_summaries": [
      {
        "identifier": "abc123",
        "pay_now": {
          "pay_now_amount": {
            "currency": "EUR",
            "gross": 119000,
            "net": 100000
          }
        },
        "pay_now_excluding_sublines": {
          "pay_now_amount": {
            "currency": "EUR",
            "gross": 119000,
            "net": 100000
          }
        },
        "rent": [
          {
            "duration": 12,
            "monthly_amount": {
              "currency": "EUR",
              "gross": 119000,
              "net": 100000
            }
          }
        ],
        "rent_excluding_sublines": [
          {
            "duration": 12,
            "monthly_amount": {
              "currency": "EUR",
              "gross": 119000,
              "net": 100000
            }
          }
        ],
        "total_pay_now": {
          "pay_now_amount": {
            "currency": "EUR",
            "gross": 119000,
            "net": 100000
          }
        },
        "total_rent": [
          {
            "duration": 12,
            "monthly_amount": {
              "currency": "EUR",
              "gross": 119000,
              "net": 100000
            }
          }
        ]
      }
    ],
    "rent_info": {
      "rent_only_amount": {
        "currency": "EUR",
        "gross": 119000,
        "net": 100000
      },
      "tenure_lines": [
        {
          "amount": {
            "currency": "EUR",
            "gross": 119000,
            "net": 100000
          },
          "duration": 6
        }
      ],
      "total_rent": {
        "currency": "EUR",
        "gross": 119000,
        "net": 100000
      }
    },
    "should_show_instead_of_amount": false,
    "total_amount_first_payment": {
      "currency": "EUR",
      "gross": 119000,
      "net": 100000
    },
    "total_amount_first_payment_without_shipping": {
      "currency": "EUR",
      "gross": 119000,
      "net": 100000
    },
    "total_purchase_amount": {
      "currency": "EUR",
      "gross": 119000,
      "net": 100000
    }
  },
  "redirect_to_superseding_offer_url": "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",
  "shipping": {
    "is_in_store_pickup": false,
    "price": {
      "currency": "EUR",
      "gross": 119000,
      "net": 100000
    },
    "seller_shipping_reference": "Sandbox Shipping Service"
  },
  "shipping_address": {
    "city": "abc123",
    "country_code": "DE",
    "line1": "abc123",
    "line2": "aaa",
    "postal_code": "abc123",
    "recipient_name": "abc123",
    "region": "abc123"
  },
  "status": "voided",
  "success_redirect": "abc123",
  "superseded_by_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "updated_at": "1970-01-01T00:00:01Z"
}