fa134b7fc959

latestOpenAPI 3.0.32026-08-05174296703.4 KB
offer

updateShippingAddressWithEndCustomerInfo offer

Update an offer's shipping address as well as end customer info

put/offers/{id}/update-shipping-address-with-end-customer-info

Path parameters

idstring regexp required

Offer ID

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

Offer ID

Request body

Example request

{
  "end_customer": {
    "billing_address": {
      "city": "abc123",
      "country_code": "DE",
      "line1": "abc123",
      "line2": "aaa",
      "postal_code": "abc123",
      "region": "abc123"
    },
    "company_registration_number": "abc123",
    "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
    "language": "de",
    "name": "aa",
    "not_vat_registered": false,
    "tax_number": "abc123",
    "type": "Partnership",
    "vat_number": "abc123"
  },
  "end_user": {
    "first_name": "aa",
    "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
    "last_name": "aa",
    "phone_country_code": "abc123",
    "phone_national_number": "abc123",
    "phone_type": "abc123"
  },
  "shipping_address": {
    "city": "abc123",
    "country_code": "DE",
    "line1": "abc123",
    "line2": "aaa",
    "postal_code": "abc123",
    "recipient_name": "abc123",
    "region": "abc123"
  }
}

Response

OK response.

Example response

{
  "end_customer": {
    "billing_address": {
      "city": "abc123",
      "country_code": "DE",
      "line1": "abc123",
      "line2": "aaa",
      "postal_code": "abc123",
      "region": "abc123"
    },
    "company_registration_number": "abc123",
    "email_domain": "abc123",
    "group": "abc123",
    "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
    "in_migration": false,
    "is_new": false,
    "language": "abc123",
    "name": "abc123",
    "not_vat_registered": false,
    "psp_provider": "abc123",
    "risk_status": "abc123",
    "tax_number": "abc123",
    "type": "Partnership",
    "vat_number": "abc123"
  },
  "end_user": {
    "email": "abc123",
    "first_name": "abc123",
    "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
    "is_new": false,
    "last_name": "abc123",
    "phone_number": {
      "country_code": "abc123",
      "country_prefix": "abc123",
      "international_format": "abc123",
      "national": "abc123",
      "number": "abc123"
    },
    "phone_type": "abc123"
  },
  "offer": {
    "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"
  },
  "shipping_address": {
    "city": "abc123",
    "country_code": "DE",
    "line1": "abc123",
    "line2": "aaa",
    "postal_code": "abc123",
    "recipient_name": "abc123",
    "region": "abc123"
  }
}