{"openapi":"3.0.3","info":{"title":"Topi public API","description":"API for partners and customer-facing front clients","version":"1.0.0"},"servers":[{"url":"https://api.topi-staging.eu"},{"url":"https://api.topi.eu"},{"url":"https://api.topi-sandbox-staging.eu/"},{"url":"https://api.topi-sandbox.eu/"}],"paths":{"/branding/offers/{id}":{"get":{"tags":["branding"],"summary":"getBrandingInfo branding","description":"Fetch the branding info for a specific offer to display in the app","operationId":"branding#getBrandingInfo","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingInfo"},"example":{"logo_url":"abc123"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["branding:read"]}]}},"/branding/offers/{id}/anonymized":{"get":{"tags":["branding"],"summary":"getBrandingInfoAnonymized branding","description":"Fetch the branding info for a specific anonymized offer to display in the app","operationId":"branding#getBrandingInfoAnonymized","parameters":[{"name":"token","in":"query","description":"the shared token","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"the shared token","example":"abc123"},"example":"abc123"},{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingInfo"},"example":{"logo_url":"abc123"}}}},"400":{"description":"InvalidToken: shared token is invalid","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/crm/contacts":{"post":{"tags":["crm"],"summary":"CreateContact crm","operationId":"crm#CreateContact","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactsPayload"},"example":{"properties":{"company":"Biglytics","email":"bcooper@biglytics.net","firstname":"Bryan","lastname":"Cooper","phone":"(877) 929-0687","website":"biglytics.net"}}}}},"responses":{"201":{"description":"Created response."}}}},"/discount/validate":{"post":{"tags":["discount"],"summary":"validate discount","description":"validates the provided discount code","operationId":"discount#validate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateDiscountRequest2"},"example":{"discount_code":"abc123","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateResponseBody"},"example":{"is_valid":false}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"InvalidDiscountCodeError: Response for discount code error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidDiscountCodeError"},"example":{"message":"abc123","type":"not_new_end_customer"}}}}},"security":[{"OAuth2Topi_header_Authorization":["discount:read"]}]}},"/feedback/accessory_feedback":{"post":{"tags":["feedback"],"summary":"addAccessoryFeedback feedback","description":"provide feedback regarding accessories","operationId":"feedback#addAccessoryFeedback","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAccessoryFeedback"},"example":{"customer_feedback":"abc123","offer_id":"abc123","offer_line_id":"abc123"}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAccessoryCreationResponse"},"example":{"customer_feedback":"abc123","id":"abc123","offer_id":"abc123","offer_line_id":"abc123"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/offers/{id}":{"get":{"tags":["offer"],"summary":"show offer","description":"Fetch a single offer","operationId":"offer#show","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForEndCustomer"},"example":{"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"},"company_registration_number":"123456789","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"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:read"]}]}},"/offers/{id}/accept":{"put":{"tags":["offer"],"summary":"accept offer","description":"Accept an offer","operationId":"offer#accept","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptRequestBody"},"example":{"discount_code":"abc123","last_updated_at":"1970-01-01T00:00:01Z","seon_session_token":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForEndCustomer"},"example":{"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"},"company_registration_number":"123456789","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"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"IncompatibleContractualEntity: Conflict response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"OutOfDate: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:edit"]}]}},"/offers/{id}/anonymized":{"get":{"tags":["offer"],"summary":"anonymized offer","description":"Fetch an anonymized offer by a valid token","operationId":"offer#anonymized","parameters":[{"name":"token","in":"query","description":"the shared token","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"the shared token","example":"abc123"},"example":"abc123"},{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymizedOffer"},"example":{"created_at":"1970-01-01T00:00:01Z","customer_has_vat_number":false,"email":"alice@example.com","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"}],"payment_method_required":false,"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"},"status":"voided"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/offers/{id}/customize-terms-services":{"put":{"tags":["offer"],"summary":"customizeOfferAndServices offer","description":"Customize which payment terms to use and selected service","operationId":"offer#customizeOfferAndServices","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractTermsAndServicesSelectionPayload"},"example":{"lines":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_contract_terms_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_services":["abc123"]}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForEndCustomer"},"example":{"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"},"company_registration_number":"123456789","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"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:edit"]}]}},"/offers/{id}/end-customer-info":{"get":{"tags":["end_customer"],"summary":"getEndCustomerInfo end_customer","description":"Get end customer info for an offer","operationId":"end_customer#getEndCustomerInfo","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomerInfo"},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"}}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:read"]}]},"put":{"tags":["end_customer"],"summary":"updateEndCustomerInfo end_customer","description":"Update end customer info for an offer","operationId":"end_customer#updateEndCustomerInfo","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomerInfoUpdate"},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"}}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomerInfo"},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"}}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"ValidationError: Validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"errors":[{"code":"abc123","field":"abc123","message":"abc123"}],"message":"abc123"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:edit"]}]}},"/offers/{id}/id-verification":{"get":{"tags":["offer"],"summary":"getIDVerification offer","description":"Get an ID Verification of an offer","operationId":"offer#getIDVerification","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIDVerificationResult"},"example":{"url":"abc123"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:read"]}]}},"/offers/{id}/idv-requirement":{"get":{"tags":["offer"],"summary":"showIDVRequirement offer","description":"Show the IDV requirement of an offer","operationId":"offer#showIDVRequirement","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferIDVRequirement"},"example":{"result":"not_required"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:read"]}]}},"/offers/{id}/preview-customize-terms-services":{"put":{"tags":["offer"],"summary":"previewCustomizeOfferAndServices offer","description":"Calculate offer with selected payment terms and services without mutating it","operationId":"offer#previewCustomizeOfferAndServices","parameters":[{"name":"token","in":"query","description":"the shared token","allowEmptyValue":true,"schema":{"type":"string","description":"the shared token","example":"abc123"},"example":"abc123"},{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractTermsAndServicesSelectionPayload"},"example":{"lines":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_contract_terms_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_services":["abc123"]}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymizedOffer"},"example":{"created_at":"1970-01-01T00:00:01Z","customer_has_vat_number":false,"email":"alice@example.com","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"}],"payment_method_required":false,"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"},"status":"voided"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/offers/{id}/terms_and_conditions_links":{"get":{"tags":["offer"],"summary":"getTermsAndConditionsLinks offer","description":"returns a list of the current term and conditions documents after login","operationId":"offer#getTermsAndConditionsLinks","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermsAndConditionsResult"},"example":{"applicable_terms_and_conditions":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"de":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"en":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"nl":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:read"]}]}},"/offers/{id}/terms_and_conditions_links/":{"post":{"tags":["offer"],"summary":"findTermsAndConditionsLinks offer","description":"Fetch the terms and conditions links based on params. If no params are provided, the links will be returned in the language of the end customer.","operationId":"offer#findTermsAndConditionsLinks","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindTermsAndConditionsLinksRequestBody"},"example":{"params":{"language":"abc123"}}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermsAndConditionsResult"},"example":{"applicable_terms_and_conditions":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"de":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"en":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"nl":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}}}},"/offers/{id}/terms_and_conditions_links/anonymized":{"get":{"tags":["offer"],"summary":"getAnonymizedTermsAndConditionsLinks offer","description":"returns a list of the current term and conditions documents before login","operationId":"offer#getAnonymizedTermsAndConditionsLinks","parameters":[{"name":"token","in":"query","description":"the shared token","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"the shared token","example":"abc123"},"example":"abc123"},{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermsAndConditionsResult"},"example":{"applicable_terms_and_conditions":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"de":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"en":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"nl":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/offers/{id}/update-shipping-address":{"put":{"tags":["offer"],"summary":"updateShippingAddress offer","description":"Update an offer's shipping address","operationId":"offer#updateShippingAddress","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingAddress"},"example":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","recipient_name":"abc123","region":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForEndCustomer"},"example":{"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"},"company_registration_number":"123456789","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"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"OfferNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"UnsupportedSalesChannel: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:edit"]}]}},"/offers/{id}/update-shipping-address-with-end-customer-info":{"put":{"tags":["offer"],"summary":"updateShippingAddressWithEndCustomerInfo offer","description":"Update an offer's shipping address as well as end customer info","operationId":"offer#updateShippingAddressWithEndCustomerInfo","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShippingAddressWithEndCustomerInfoRequestBody"},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"}}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShippingAddressWithEndCustomerInfoResult"},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"},"company_registration_number":"123456789","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"}}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"OfferNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"UnsupportedSalesChannel: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:edit"]}]}},"/ops/allowlist":{"post":{"tags":["ops"],"summary":"addOrUpdateOps allowlist","description":"Add or update multiple rows to the allowlist","operationId":"allowlist#addOrUpdateOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrUpdateOpsRequestBody"},"example":{"rows":[{"comment":"abc123","email":"abc123","transaction_limit":1}]}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AllowlistItem"},"example":[{"comment":"abc123","email":"abc123","transaction_limit":1}]},"example":[{"comment":"abc123","email":"abc123","transaction_limit":1}]}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/allowlist/all":{"get":{"tags":["ops"],"summary":"getAllOps allowlist","description":"Get all customers in the allowlist","operationId":"allowlist#getAllOps","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AllowlistItem"},"example":[{"comment":"abc123","email":"abc123","transaction_limit":1}]},"example":[{"comment":"abc123","email":"abc123","transaction_limit":1}]}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:read"]}]}},"/ops/allowlist/remove":{"post":{"tags":["ops"],"summary":"removeOps allowlist","description":"Remove multiple rows from the allowlist","operationId":"allowlist#removeOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveOpsRequestBody"},"example":{"emails":["abc123"]}}}},"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/asset/buyout-requests":{"get":{"tags":["ops"],"summary":"listBuyoutRequestsOps Asset","description":"Fetch all asset buyout requests for Ops","operationId":"Asset#listBuyoutRequestsOps","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuyoutRequest"},"example":[{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","asset_status":"shipped","created_at":"1970-01-01T00:00:01Z","price_net":{"amount":34000,"currency":"EUR"},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]},"example":[{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","asset_status":"shipped","created_at":"1970-01-01T00:00:01Z","price_net":{"amount":34000,"currency":"EUR"},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:read"]}]}},"/ops/asset/buyout-requests/{asset_id}":{"delete":{"tags":["ops"],"summary":"deleteBuyoutRequestOps Asset","description":"Delete a buyout request by asset ID for Ops","operationId":"Asset#deleteBuyoutRequestOps","parameters":[{"name":"asset_id","in":"path","description":"topi asset ID","required":true,"schema":{"type":"string","description":"topi asset ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:edit"]}]}},"/ops/asset/return-requests":{"get":{"tags":["ops"],"summary":"listReturnRequestsOps Asset","description":"Fetch all asset return requests for Ops","operationId":"Asset#listReturnRequestsOps","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnRequestsListResult"},"example":{"return_requests":[{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","company_name":"abc123","created_at":"1970-01-01T00:00:01Z","email":"abc123","end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requested_at":"1970-01-01T00:00:01Z","return_fee":{"amount":34000,"currency":"EUR"},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:read"]}]}},"/ops/asset/{id}":{"get":{"tags":["ops"],"summary":"getAsset Asset","description":"get Asset by id","operationId":"Asset#getAsset","parameters":[{"name":"id","in":"path","description":"topi asset ID","required":true,"schema":{"type":"string","description":"topi asset ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetDetail"},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","serial_number":"BA-3456786-334-9","status":"shipped","subtitle":"abc123","title":"Pro Laptop 64GB","txlog_status":"abc123"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:read"]}]},"patch":{"tags":["ops"],"summary":"updateStatus Asset","description":"Modify Asset Status","operationId":"Asset#updateStatus","parameters":[{"name":"id","in":"path","description":"topi asset ID","required":true,"schema":{"type":"string","description":"topi asset ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStatusRequestBody"},"example":{"state":"shipped"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetDetail"},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","serial_number":"BA-3456786-334-9","status":"shipped","subtitle":"abc123","title":"Pro Laptop 64GB","txlog_status":"abc123"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:edit"]}]}},"/ops/asset/{id}/calculate-termination-fees":{"post":{"tags":["ops"],"summary":"calculateTerminationFeesOps Asset","description":"Calculate termination fees for asset","operationId":"Asset#calculateTerminationFeesOps","parameters":[{"name":"id","in":"path","description":"topi asset ID","required":true,"schema":{"type":"string","description":"topi asset ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculateTerminationFeesOpsRequestBody"},"example":{"actual_tenure_override":1,"fetch_realtime_trade_in_price":false,"trade_in_price_override":1}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminationFeesOps"},"example":{"asset_details":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","serial_number":"BA-3456786-334-9","status":"shipped","subtitle":"abc123","title":"Pro Laptop 64GB","txlog_status":"abc123"},"buy_out_fee_net":{"amount":34000,"currency":"EUR"},"calculation_details":{"buy_out_profit_loading_percent":1,"collected_rent_actual_tenure":1,"contract_start_date":"1970-01-01T00:00:01Z","difference_to_expected_revenue":1,"expected_revenue_total":1,"gross_profit_in_percent":1,"purchase_price_net":{"amount":34000,"currency":"EUR"},"rv_in_percent":1,"target_margin_in_percent":1,"tenure_actual":1,"tenure_on_contract":1,"tenure_remaining":1,"total_revenue":1,"trade_in_price":1},"return_fee_net":{"amount":34000,"currency":"EUR"}}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:edit"]}]}},"/ops/asset/{id}/clear-serial-number":{"patch":{"tags":["ops"],"summary":"clearCanceledAssetSerialNumber Asset","description":"Clear asset serial number for asset canceled by ops","operationId":"Asset#clearCanceledAssetSerialNumber","parameters":[{"name":"id","in":"path","description":"topi asset ID","required":true,"schema":{"type":"string","description":"topi asset ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:edit"]}]}},"/ops/branding":{"get":{"tags":["ops"],"summary":"list branding","description":"Fetch all branding configurations","operationId":"branding#list","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Branding"},"example":[{"created_at":"1970-01-01T00:00:01Z","email_logo_url":"abc123","enable_transactional_emails":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","info_hub_url":"abc123","logo_url":"abc123","name":"abc123","updated_at":"1970-01-01T00:00:01Z"}]},"example":[{"created_at":"1970-01-01T00:00:01Z","email_logo_url":"abc123","enable_transactional_emails":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","info_hub_url":"abc123","logo_url":"abc123","name":"abc123","updated_at":"1970-01-01T00:00:01Z"}]}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-branding:read"]}]},"post":{"tags":["ops"],"summary":"createBranding branding","description":"Create a new branding config","operationId":"branding#createBranding","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBrandingRequestBody"},"example":{"branding":{"email_logo_url":"abc123","enable_transactional_emails":false,"info_hub_url":"abc123","logo_url":"abc123","name":"abc123"}}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branding"},"example":{"created_at":"1970-01-01T00:00:01Z","email_logo_url":"abc123","enable_transactional_emails":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","info_hub_url":"abc123","logo_url":"abc123","name":"abc123","updated_at":"1970-01-01T00:00:01Z"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-branding:edit"]}]}},"/ops/branding/sellers":{"get":{"tags":["ops"],"summary":"listForSellers branding","description":"Fetch all branding configurations for sellers","operationId":"branding#listForSellers","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BrandingForSeller"},"example":[{"created_at":"1970-01-01T00:00:01Z","email_logo_url":"abc123","enable_transactional_emails":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","info_hub_url":"abc123","logo_url":"abc123","name":"abc123","seller_id":"abc123","seller_name":"abc123","seller_pretty_name":"abc123","updated_at":"1970-01-01T00:00:01Z"}]},"example":[{"created_at":"1970-01-01T00:00:01Z","email_logo_url":"abc123","enable_transactional_emails":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","info_hub_url":"abc123","logo_url":"abc123","name":"abc123","seller_id":"abc123","seller_name":"abc123","seller_pretty_name":"abc123","updated_at":"1970-01-01T00:00:01Z"}]}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-branding:read"]}]},"post":{"tags":["ops"],"summary":"assignBrandingToSeller branding","description":"Assign a branding config to a seller","operationId":"branding#assignBrandingToSeller","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignBrandingToSellerRequestBody"},"example":{"branding_id":"abc123","seller_id":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingForSeller"},"example":{"created_at":"1970-01-01T00:00:01Z","email_logo_url":"abc123","enable_transactional_emails":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","info_hub_url":"abc123","logo_url":"abc123","name":"abc123","seller_id":"abc123","seller_name":"abc123","seller_pretty_name":"abc123","updated_at":"1970-01-01T00:00:01Z"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-branding:edit"]}]}},"/ops/branding/sellers/{seller_id}/clear":{"post":{"tags":["ops"],"summary":"clearBrandingFromSeller branding","description":"Clear the branding config from a seller","operationId":"branding#clearBrandingFromSeller","parameters":[{"name":"seller_id","in":"path","description":"ID of the seller to clear the branding config from","required":true,"schema":{"type":"string","description":"ID of the seller to clear the branding config from","example":"abc123"},"example":"abc123"}],"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-branding:edit"]}]}},"/ops/branding/{branding_id}":{"put":{"tags":["ops"],"summary":"updateBranding branding","description":"Update a branding config","operationId":"branding#updateBranding","parameters":[{"name":"branding_id","in":"path","description":"ID of the branding config to update","required":true,"schema":{"type":"string","description":"ID of the branding config to update","example":"abc123"},"example":"abc123"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBrandingRequestBody"},"example":{"branding":{"email_logo_url":"abc123","enable_transactional_emails":false,"info_hub_url":"abc123","logo_url":"abc123","name":"abc123"}}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branding"},"example":{"created_at":"1970-01-01T00:00:01Z","email_logo_url":"abc123","enable_transactional_emails":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","info_hub_url":"abc123","logo_url":"abc123","name":"abc123","updated_at":"1970-01-01T00:00:01Z"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-branding:edit"]}]}},"/ops/credit-limit":{"put":{"tags":["ops"],"summary":"updateOpsCreditLimits offer","description":"Update the credit limits for ops","operationId":"offer#updateOpsCreditLimits","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOpsCreditLimitsRequestBody"},"example":{"rows":[{"available_credit_limit":1,"available_credit_limit_currency":"abc123","comments":"abc123","credit_limit":1,"credit_limit_currency":"abc123","end_customer_id":"abc123"}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CreditLimitItem"},"example":[{"available_credit_limit":1,"available_credit_limit_currency":"abc123","comments":"abc123","credit_limit":1,"credit_limit_currency":"abc123","end_customer_id":"abc123"}]},"example":[{"available_credit_limit":1,"available_credit_limit_currency":"abc123","comments":"abc123","credit_limit":1,"credit_limit_currency":"abc123","end_customer_id":"abc123"}]}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/discount":{"get":{"tags":["ops"],"summary":"listDiscounts discount","description":"List all discount in our system or discounts for a specific seller","operationId":"discount#listDiscounts","parameters":[{"name":"seller_id","in":"query","description":"seller ID","allowEmptyValue":true,"schema":{"type":"string","description":"seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Discount"},"example":[{"allowed_usage_count":1,"code":"abc123","created_at":"1970-01-01T00:00:01Z","description":"abc123","disabled_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","minimum_merchandise_value":{"amount":34000,"currency":"EUR"},"rules":{"abc123":"abc123"},"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"fixed_initial_rent_waiver","updated_at":"1970-01-01T00:00:01Z","usage_count":1,"valid_from":"1970-01-01T00:00:01Z","valid_until":"1970-01-01T00:00:01Z"}]},"example":[{"allowed_usage_count":1,"code":"abc123","created_at":"1970-01-01T00:00:01Z","description":"abc123","disabled_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","minimum_merchandise_value":{"amount":34000,"currency":"EUR"},"rules":{"abc123":"abc123"},"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"fixed_initial_rent_waiver","updated_at":"1970-01-01T00:00:01Z","usage_count":1,"valid_from":"1970-01-01T00:00:01Z","valid_until":"1970-01-01T00:00:01Z"}]}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["discount:read"]}]},"post":{"tags":["ops"],"summary":"createDiscount discount","description":"Create a discount","operationId":"discount#createDiscount","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDiscount"},"example":{"allowed_usage_count":1,"code":"abc123","description":"abc123","minimum_merchandise_value":{"amount":34000,"currency":"EUR"},"rules":{"abc123":"abc123"},"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"fixed_initial_rent_waiver","valid_from":"1970-01-01T00:00:01Z","valid_until":"1970-01-01T00:00:01Z"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["discount:edit"]}]}},"/ops/discount/{id}":{"get":{"tags":["ops"],"summary":"showDiscount discount","description":"Show discount info","operationId":"discount#showDiscount","parameters":[{"name":"id","in":"path","description":"discount ID","required":true,"schema":{"type":"string","description":"discount ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"},"example":{"allowed_usage_count":1,"code":"abc123","created_at":"1970-01-01T00:00:01Z","description":"abc123","disabled_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","minimum_merchandise_value":{"amount":34000,"currency":"EUR"},"rules":{"abc123":"abc123"},"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"fixed_initial_rent_waiver","updated_at":"1970-01-01T00:00:01Z","usage_count":1,"valid_from":"1970-01-01T00:00:01Z","valid_until":"1970-01-01T00:00:01Z"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["discount:read"]}]}},"/ops/discount/{id}/disable":{"put":{"tags":["ops"],"summary":"disableDiscount discount","description":"Disable a discount","operationId":"discount#disableDiscount","parameters":[{"name":"id","in":"path","description":"discount ID","required":true,"schema":{"type":"string","description":"discount ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["discount:edit"]}]}},"/ops/discount/{id}/enable":{"put":{"tags":["ops"],"summary":"enableDiscount discount","description":"Enable a discount","operationId":"discount#enableDiscount","parameters":[{"name":"id","in":"path","description":"discount ID","required":true,"schema":{"type":"string","description":"discount ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["discount:edit"]}]}},"/ops/discount/{id}/extend":{"put":{"tags":["ops"],"summary":"extendDiscountValidity discount","description":"Extend a discount's valid start and/or end datetimes","operationId":"discount#extendDiscountValidity","parameters":[{"name":"id","in":"path","description":"discount ID","required":true,"schema":{"type":"string","description":"discount ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendDiscountValidityRequestBody"},"example":{"valid_from":"1970-01-01T00:00:01Z","valid_until":"1970-01-01T00:00:01Z"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["discount:edit"]}]}},"/ops/end-customer-info/{id}":{"put":{"tags":["ops"],"summary":"updateEndCustomerInfoOps end_customer","description":"Update end customer info (for Ops)","operationId":"end_customer#updateEndCustomerInfoOps","parameters":[{"name":"id","in":"path","description":"end-customer ID","required":true,"schema":{"type":"string","description":"end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEndCustomerInfoOpsRequestBody"},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"abc123","email_domain":"abc123","force_update_email":false,"group":"abc123","language":"de","name":"aa","not_vat_registered":false,"tax_number":"abc123","type":"Partnership","vat_number":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomer"},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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,"risk_status":"abc123","tax_number":"abc123","type":"Partnership","vat_number":"abc123"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"ValidationError: Validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"errors":[{"code":"abc123","field":"abc123","message":"abc123"}],"message":"abc123"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:edit"]}]}},"/ops/end-customers":{"get":{"tags":["ops"],"summary":"getEndCustomersOps end_customer","description":"Fetch all the end customers","operationId":"end_customer#getEndCustomersOps","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EndCustomerSummary"},"example":[{"available_credit_limit":1,"comments":"abc123","country_code":"DE","credit_limit":1,"currency":"abc123","email_domain":"abc123","id":"739b63c2-9e58-4964-b38d-4ebb424de242","idv_requirement_status":"abc123","language":"abc123","name":"abc123","psp":"stripe","risk_status":"abc123"}]},"example":[{"available_credit_limit":1,"comments":"abc123","country_code":"DE","credit_limit":1,"currency":"abc123","email_domain":"abc123","id":"739b63c2-9e58-4964-b38d-4ebb424de242","idv_requirement_status":"abc123","language":"abc123","name":"abc123","psp":"stripe","risk_status":"abc123"}]}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:read"]}]},"post":{"tags":["ops"],"summary":"createEndCustomerOps end_customer","description":"Create a new end customer (for Ops)","operationId":"end_customer#createEndCustomerOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomerCreate"},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"abc123","currency":"abc123","email_domain":"abc123","group":"abc123","name":"abc123","tax_number":"abc123","vat_number":"abc123"}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomer"},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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,"risk_status":"abc123","tax_number":"abc123","type":"Partnership","vat_number":"abc123"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"ValidationError: Validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"errors":[{"code":"abc123","field":"abc123","message":"abc123"}],"message":"abc123"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:edit"]}]}},"/ops/end-customers/merge":{"put":{"tags":["ops"],"summary":"mergeEndCustomersOps end_customer","description":"ops endpoint to merge two end customers","operationId":"end_customer#mergeEndCustomersOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeEndCustomerPayload"},"example":{"destination_id":"739b63c2-9e58-4964-b38d-4ebb424de242","source_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:edit"]}]}},"/ops/end-customers/migrate-user/{user_id}":{"put":{"tags":["ops"],"summary":"migrateUserToEndCustomerOps end_customer","description":"ops endpoint to migrate one user to a different end customer","operationId":"end_customer#migrateUserToEndCustomerOps","parameters":[{"name":"user_id","in":"path","description":"end-user ID","required":true,"schema":{"type":"string","description":"end-user ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrateUserPayload"},"example":{"destination_id":"739b63c2-9e58-4964-b38d-4ebb424de242","source_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:edit"]}]}},"/ops/end-customers/offer-nudge-allow":{"put":{"tags":["ops"],"summary":"allowEndCustomerOfferNudgeOps end_customer","description":"allow sending offer nudge emails to an end customer","operationId":"end_customer#allowEndCustomerOfferNudgeOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenBankingLinkOpsPayload"},"example":{"end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:edit"]}]}},"/ops/end-customers/offer-nudge-exclude":{"put":{"tags":["ops"],"summary":"excludeEndCustomerFromOfferNudgeOps end_customer","description":"stop sending offer nudge emails to an end customer","operationId":"end_customer#excludeEndCustomerFromOfferNudgeOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenBankingLinkOpsPayload"},"example":{"end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:edit"]}]}},"/ops/end-customers/open-banking-link":{"post":{"tags":["ops"],"summary":"createOpenBankingLinkOps end_customer","description":"Create an open banking link for an end customer, for ops to share directly with them","operationId":"end_customer#createOpenBankingLinkOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenBankingLinkOpsPayload"},"example":{"end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenBankingLinkOpsResult"},"example":{"open_banking_link":"abc123"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:edit"]}]}},"/ops/end-customers/send-open-banking-email":{"post":{"tags":["ops"],"summary":"sendOpenBankingEmailOps end_customer","description":"Send the open banking email to the end customer associated with an offer. The sales agent is CC'd if one is assigned.","operationId":"end_customer#sendOpenBankingEmailOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendOpenBankingEmailOpsPayload"},"example":{"offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:edit"]}]}},"/ops/end-customers/{end_customer_id}/offer-nudge-excluded":{"get":{"tags":["ops"],"summary":"checkEndCustomerExcludedFromOfferNudgeOps end_customer","description":"check if an end customer is excluded from offer nudge emails","operationId":"end_customer#checkEndCustomerExcludedFromOfferNudgeOps","parameters":[{"name":"end_customer_id","in":"path","description":"end customer ID","required":true,"schema":{"type":"string","description":"end customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"boolean","example":false},"example":false}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:read"]}]}},"/ops/end-customers/{id}":{"get":{"tags":["ops"],"summary":"getEndCustomerDetailsOps end_customer","description":"Get end customer details for ops","operationId":"end_customer#getEndCustomerDetailsOps","parameters":[{"name":"id","in":"path","description":"end-customer ID","required":true,"schema":{"type":"string","description":"end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomerForOps"},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"abc123","contractual_entity":"abc123","currency":"abc123","email_domain":"abc123","end_users":[{"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"}],"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"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-end-customer:read"]}]}},"/ops/first_party_service_information":{"get":{"tags":["ops"],"summary":"list_information pricing-category","description":"Fetch all pricing categories information","operationId":"pricing-category#list_information","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingCategoryInfoResult"},"example":{"pricing_categories":[{"asset_id_prefix":"abc123","asset_reference":"abc123","asset_title":"abc123","replace_title":false,"service_type":"abc123"}]}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-pricing-category:read"]}]},"post":{"tags":["ops"],"summary":"add_information pricing-category","description":"Add pricing categories information","operationId":"pricing-category#add_information","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPricingCategoryInfo"},"example":{"asset_id_prefix":"abc123","asset_reference":"abc123","asset_title":"abc123","replace_title":false,"service_type":"abc123"}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingCategoryInfo"},"example":{"asset_id_prefix":"abc123","asset_reference":"abc123","asset_title":"abc123","replace_title":false,"service_type":"abc123"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-pricing-category:edit"]}]}},"/ops/first_party_services/clear_central_catalog":{"delete":{"tags":["ops"],"summary":"clearCentralCatalogData catalog","description":"delete products from central_catalog","operationId":"catalog#clearCentralCatalogData","responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/first_party_services/product/{product_id}":{"get":{"tags":["ops"],"summary":"ListFirstPartyServicesForProduct catalog","description":"List first party services for a product","operationId":"catalog#ListFirstPartyServicesForProduct","parameters":[{"name":"product_id","in":"path","description":"topi product ID","required":true,"schema":{"type":"string","description":"topi product ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FirstPartyServiceProductOverride"},"example":[{"additional_values":{"accessory_type":"experiment_charger","deductible_price":{"currency":"EUR","gross":119000,"net":100000},"images":{"url1x":"abc123","url2x":"abc123","url3x":"abc123"}},"disabled":false,"monthly_price":{"currency":"EUR","gross":119000,"net":100000},"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"topi_replace"}]},"example":[{"additional_values":{"accessory_type":"experiment_charger","deductible_price":{"currency":"EUR","gross":119000,"net":100000},"images":{"url1x":"abc123","url2x":"abc123","url3x":"abc123"}},"disabled":false,"monthly_price":{"currency":"EUR","gross":119000,"net":100000},"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"topi_replace"}]}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]},"post":{"tags":["ops"],"summary":"AddFirstPartyServiceOverrideForProduct catalog","description":"Add a first party service override for a product","operationId":"catalog#AddFirstPartyServiceOverrideForProduct","parameters":[{"name":"product_id","in":"path","description":"The internal ID for the product","required":true,"schema":{"type":"string","description":"The internal ID for the product","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFirstPartyServiceOverrideForProductRequestBody"},"example":{"additional_values":{"accessory_type":"experiment_charger","deductible_price":{"currency":"EUR","gross":119000,"net":100000},"images":{"url1x":"abc123","url2x":"abc123","url3x":"abc123"}},"disabled":false,"monthly_price":{"currency":"EUR","gross":119000,"net":100000},"type":"topi_replace"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirstPartyServiceProductOverride"},"example":{"additional_values":{"accessory_type":"experiment_charger","deductible_price":{"currency":"EUR","gross":119000,"net":100000},"images":{"url1x":"abc123","url2x":"abc123","url3x":"abc123"}},"disabled":false,"monthly_price":{"currency":"EUR","gross":119000,"net":100000},"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"topi_replace"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/first_party_services/product/{product_id}/{service_type}":{"delete":{"tags":["ops"],"summary":"RemoveFirstPartyServiceOverrideForProduct catalog","description":"Remove a first party service override for a product","operationId":"catalog#RemoveFirstPartyServiceOverrideForProduct","parameters":[{"name":"product_id","in":"path","description":"topi order ID","required":true,"schema":{"type":"string","description":"topi order ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"service_type","in":"path","description":"The kind of first party service","required":true,"schema":{"type":"string","example":"topi_replace","enum":["topi_repair","topi_replace","demo_first_party_service","topi_accessory","topi_data_deletion_certificate","topi_care_plus_synaxon","topi_care_plus_michaelag"]},"example":"topi_replace"}],"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/ingest-transaction-log-asset":{"put":{"tags":["ops"],"summary":"ingestTransactionLogAsset offer","operationId":"offer#ingestTransactionLogAsset","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionLogAssetPayload"},"example":{"assets":[{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","serial_number":"abc123","title":"abc123"}],"end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","transaction_date_created_at":"abc123","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResult"},"example":{"assets":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","metadata":{"tracking_number":"123456"},"offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","status":"confirmed"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/invoices":{"post":{"tags":["ops"],"summary":"addInvoices invoice","description":"Add invoices for an end customer by ops","operationId":"invoice#addInvoices","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddInvoicesRequestBody"},"example":{"invoices":[{"amount":{"currency":"EUR","gross":119000,"net":100000},"confirm_overwrite":false,"contract_type":"rent","duration":6,"encrypted_invoice_number":"abc123","file":"abc123","invoice_date":"abc123","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","transaction_type":"invoice","withdrawal_date":"1970-01-01T00:00:01Z"},{"amount":{"currency":"EUR","gross":119000,"net":100000},"confirm_overwrite":false,"contract_type":"rent","duration":6,"encrypted_invoice_number":"abc123","file":"abc123","invoice_date":"abc123","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","transaction_type":"invoice","withdrawal_date":"1970-01-01T00:00:01Z"}],"send_email":false}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"409":{"description":"InvoiceUploadConflict: Conflict response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"ServiceUnavailable: Service Unavailable response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-invoice:edit"]}]}},"/ops/offers":{"post":{"tags":["ops"],"summary":"addOfferOps offer","description":"create a new offer for customer","operationId":"offer#addOfferOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOfferOpsRequestBody"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"customer":{"company":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"123456789","name":"abc123","tax_number":"abc123","type":"Partnership","vat_number":"DE123456789"},"customer_group":"abc123","email":"alice@example.com","full_name":"abc123"},"expires_at":"1970-01-01T00:00:01Z","lines":[{"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"}],"pretty_id":"abc123","price":{"currency":"EUR","gross":119000,"net":100000},"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_references":[{"reference":"123ab-5343","source":"sap"}],"subtitle":"abc123","title":"abc123"}],"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","shipping_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"shipping_info":{"is_in_store_pickup":false,"price":{"currency":"EUR","gross":119000,"net":100000},"seller_shipping_reference":"Sandbox Shipping Service"},"supersedes_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForOps"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"ServiceUnavailable: Service Unavailable response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/all":{"get":{"tags":["ops"],"summary":"getAllOps offer","description":"Fetch all the offers with filters on status and seller","operationId":"offer#getAllOps","parameters":[{"name":"seller_id","in":"query","description":"Seller ID","allowEmptyValue":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"status","in":"query","description":"Offer status","allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string","example":"voided","enum":["created","voided","accepted","expired","rejected","pending_review","declined","id_verification_expired"]},"description":"Offer status","example":["voided"]},"example":["voided"]},{"name":"seller_offer_reference","in":"query","description":"Partner's own reference for this offer","allowEmptyValue":true,"schema":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"example":"abc123"},{"name":"pending_serial_numbers","in":"query","description":"Accepted offer that serial number has been pending","allowEmptyValue":true,"schema":{"type":"boolean","description":"Accepted offer that serial number has been pending","example":false},"example":false},{"name":"end_customer_id","in":"query","description":"Id of the end customer","allowEmptyValue":true,"schema":{"type":"string","description":"Id of the end customer","example":"abc123"},"example":"abc123"},{"name":"contract_entity","in":"query","description":"Contract entity","allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string","example":"abc123"},"description":"Contract entity","example":["abc123"]},"example":["abc123"]}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OfferSummaryForOps"},"example":[{"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"},"company_registration_number":"123456789","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"}}]},"example":[{"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"},"company_registration_number":"123456789","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"}}]}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:read"]}]}},"/ops/offers/all/paginated":{"get":{"tags":["ops"],"summary":"getAllOpsPaginated offer","description":"Fetch offers with filters on status and seller using cursor pagination","operationId":"offer#getAllOpsPaginated","parameters":[{"name":"page","in":"query","description":"Which page number to fetch (zero-indexed)","allowEmptyValue":true,"schema":{"type":"integer","description":"Which page number to fetch (zero-indexed)","default":0,"example":0,"format":"int64"},"example":0},{"name":"starting_after","in":"query","description":"A cursor to use in pagination. It will be the starting point of the list and will not be included in the results.","allowEmptyValue":true,"schema":{"type":"string","description":"A cursor to use in pagination. It will be the starting point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"ending_before","in":"query","description":"A cursor to use in pagination. It will be the ending point of the list and will not be included in the results.","allowEmptyValue":true,"schema":{"type":"string","description":"A cursor to use in pagination. It will be the ending point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"limit","in":"query","description":"How many results to return per page.","allowEmptyValue":true,"schema":{"type":"integer","description":"How many results to return per page.","default":0,"example":10,"format":"int64","minimum":0},"example":10},{"name":"seller_id","in":"query","description":"Seller ID","allowEmptyValue":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"status","in":"query","description":"Offer status","allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string","example":"voided","enum":["created","voided","accepted","expired","rejected","pending_review","declined","id_verification_expired"]},"description":"Offer status","example":["voided"]},"example":["voided"]},{"name":"seller_offer_reference","in":"query","description":"Partner's own reference for this offer","allowEmptyValue":true,"schema":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"example":"abc123"},{"name":"pending_serial_numbers","in":"query","description":"Accepted offer that serial number has been pending","allowEmptyValue":true,"schema":{"type":"boolean","description":"Accepted offer that serial number has been pending","example":false},"example":false},{"name":"end_customer_id","in":"query","description":"Id of the end customer","allowEmptyValue":true,"schema":{"type":"string","description":"Id of the end customer","example":"abc123"},"example":"abc123"},{"name":"contract_entity","in":"query","description":"Contract entity","allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string","example":"abc123"},"description":"Contract entity","example":["abc123"]},"example":["abc123"]}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedOfferSummaryForOps"},"example":{"data":[{"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"},"company_registration_number":"123456789","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"}}],"pagination":{"has_more":false}}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:read"]}]}},"/ops/offers/move":{"put":{"tags":["ops"],"summary":"moveOffersToSellerOps offer","description":"Move one or more offers from one seller to another. Associated orders and sales agents will always be moved.","operationId":"offer#moveOffersToSellerOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveOffersToSellerOpsRequestBody"},"example":{"destination_seller_id":"abc123","offer_ids":["abc123","abc123"]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveOffersToSellerOpsResponseBody"},"example":{"moved_offers":1,"moved_orders":1,"moved_sales_agents":1}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/update_customer_email":{"put":{"tags":["ops"],"summary":"updateCustomerEmailOps offer","operationId":"offer#updateCustomerEmailOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomerEmailOpsRequestBody"},"example":{"is_dry_run":false,"rows":[{"email":"abc123","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomerEmailOpsResponseBody"},"example":{"failed":[{"offer_id":"abc123","reason":"abc123"}],"failed_count":1,"updated_customers_count":1}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/{id}":{"get":{"tags":["ops"],"summary":"showOps offer","description":"Fetch a single offer in our ops tool","operationId":"offer#showOps","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForOps"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:read"]}]}},"/ops/offers/{id}/accept":{"put":{"tags":["ops"],"summary":"acceptOps offer","description":"Accept an offer","operationId":"offer#acceptOps","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptOpsRequestBody"},"example":{"discount_code":"abc123","email":"abc123","last_updated_at":"1970-01-01T00:00:01Z","seller_offer_reference":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForOps"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"IncompatibleContractualEntity: Conflict response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/{id}/decline":{"put":{"tags":["ops"],"summary":"declineOps offer","description":"Decline an offer that is pending review","operationId":"offer#declineOps","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForOps"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/{id}/end_customer_id":{"put":{"tags":["ops"],"summary":"setOfferEndCustomerId offer","description":"Set the end customer id for an existing offer","operationId":"offer#setOfferEndCustomerId","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetEndCustomerIDPayload"},"example":{"end_customer_id":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForOps"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"IncompatibleContractualEntity: Conflict response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/{id}/first_party_service_by_categories":{"put":{"tags":["ops"],"summary":"addFirstPartyServiceByPricingCategoryOps offer","description":"Add available terms to an existing offer","operationId":"offer#addFirstPartyServiceByPricingCategoryOps","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFirstPartyServiceByPricingCategoryOpsRequestBody"},"example":{"offer_line_categories":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","pricing_category":"iphone_17_pro"}],"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForOps"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/{id}/id-verification":{"get":{"tags":["ops"],"summary":"getIDVerificationOPS offer","description":"Get an ID Verification of an offer for OPS","operationId":"offer#getIDVerificationOPS","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDVerification"},"example":{"created_at":"1970-01-01T00:00:01Z","decision_id":"739b63c2-9e58-4964-b38d-4ebb424de242","end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","finalized_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","provenir_id":"739b63c2-9e58-4964-b38d-4ebb424de242","source":"abc123","source_id":"abc123","status":"abc123","updated_at":"1970-01-01T00:00:01Z","url":"abc123","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:read"]}]}},"/ops/offers/{id}/recreate-idv-url":{"post":{"tags":["ops"],"summary":"recreateIDVerificationURL offer","description":"Regenerate an ID verification URL","operationId":"offer#recreateIDVerificationURL","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDVerificationURL"},"example":{"url":"abc123"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/{id}/terms":{"post":{"tags":["ops"],"summary":"addContractTermsOps offer","description":"Add available terms to an existing offer","operationId":"offer#addContractTermsOps","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddContractTermsOpsRequestBody"},"example":{"offer_line_contract_terms":[{"contract_terms":{"contract_terms":[{"payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}],"default_contract_term":{"duration":6},"rent":{"duration":6,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}},"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","replace_all":false}],"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForOps"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/{id}/user_id":{"patch":{"tags":["ops"],"summary":"updateUserIDOps offer","description":"Update the user id for an existing offer","operationId":"offer#updateUserIDOps","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetUserIDPayload"},"example":{"user_id":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForOps"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/offers/{id}/void":{"put":{"tags":["ops"],"summary":"voidOps offer","description":"Void an offer","operationId":"offer#voidOps","parameters":[{"name":"id","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidOpsRequestBody"},"example":{"allow_pending_review":false,"superseded_by_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferForOps"},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-offer:edit"]}]}},"/ops/orders/all":{"get":{"tags":["ops"],"summary":"showAllOps order","description":"Fetch orders filtering by end customer in our ops tool","operationId":"order#showAllOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpenBankingLinkOpsPayload"},"example":{"end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdersListResult"},"example":{"orders":[{"assets":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","metadata":{"tracking_number":"123456"},"offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","status":"confirmed"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:read"]}]}},"/ops/orders/{id}":{"get":{"tags":["ops"],"summary":"showOps order","description":"Fetch a single order in our ops tool","operationId":"order#showOps","parameters":[{"name":"id","in":"path","description":"topi order ID","required":true,"schema":{"type":"string","description":"topi order ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResult"},"example":{"assets":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","metadata":{"tracking_number":"123456"},"offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","status":"confirmed"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:read"]}]}},"/ops/orders/{id}/cancel":{"post":{"tags":["ops"],"summary":"cancelOps order","description":"Cancel an order in our ops tool","operationId":"order#cancelOps","parameters":[{"name":"id","in":"path","description":"topi order ID","required":true,"schema":{"type":"string","description":"topi order ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResult"},"example":{"assets":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","metadata":{"tracking_number":"123456"},"offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","status":"confirmed"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"InvalidStatus: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:edit"]}]}},"/ops/organizations":{"get":{"tags":["ops"],"summary":"listOrganizations organizations","description":"list all organizations","operationId":"organizations#listOrganizations","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organizations"},"example":{"organizations":[{"id":"abc123","metadata":{"abc123":"abc123"},"name":"abc123"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:read"]}]}},"/ops/organizations/{org_id}/members":{"get":{"tags":["ops"],"summary":"listOrganizationMembers organizations","description":"get all members of an organization by org id","operationId":"organizations#listOrganizationMembers","parameters":[{"name":"org_id","in":"path","description":"id of the organization","required":true,"schema":{"type":"string","description":"id of the organization","example":"abc123"},"example":"abc123"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationMembers"},"example":{"organizationMembers":[{"email":"abc123","id":"abc123","name":"abc123"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"OrganizationNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/organizations/{org_id}/members/{user_id}":{"delete":{"tags":["ops"],"summary":"removeUserFromOrganization organizations","description":"remove a user from an organization","operationId":"organizations#removeUserFromOrganization","parameters":[{"name":"org_id","in":"path","description":"id of the organization","required":true,"schema":{"type":"string","description":"id of the organization","example":"abc123"},"example":"abc123"},{"name":"user_id","in":"path","description":"Auth0 Sales Agent ID","required":true,"schema":{"type":"string","description":"Auth0 Sales Agent ID","example":"auth0|63881a171828b3997ad1b3fc"},"example":"auth0|63881a171828b3997ad1b3fc"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]},"put":{"tags":["ops"],"summary":"addUserToOrganization organizations","description":"add a user to an organization","operationId":"organizations#addUserToOrganization","parameters":[{"name":"org_id","in":"path","description":"id of the organization","required":true,"schema":{"type":"string","description":"id of the organization","example":"abc123"},"example":"abc123"},{"name":"user_id","in":"path","description":"Auth0 Sales Agent ID","required":true,"schema":{"type":"string","description":"Auth0 Sales Agent ID","example":"auth0|63881a171828b3997ad1b3fc"},"example":"auth0|63881a171828b3997ad1b3fc"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"OrganizationNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/overwrite-asset-ids-with-txlog-asset-id":{"patch":{"tags":["ops"],"summary":"overwriteAssetIDsWithTxlogAssetIDs order","description":"Use to overwrite the actual asset_id with the asset_id from the txlog","operationId":"order#overwriteAssetIDsWithTxlogAssetIDs","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverwriteAssetIDsPayload"},"example":{"assets":[{"current_id":"739b63c2-9e58-4964-b38d-4ebb424de242","new_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverwriteAssetIDsResult"},"example":{"unprocessed_ids":["abc123"],"updated_assets":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:edit"]}]}},"/ops/pricing_categories":{"get":{"tags":["ops"],"summary":"list pricing-category","description":"Fetch all pricing categories","operationId":"pricing-category#list","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingCategoryListResult"},"example":{"pricing_categories":[{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","identifier":"abc123","services":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}]}]}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-pricing-category:read"]}]},"post":{"tags":["ops"],"summary":"create pricing-category","description":"Create new pricing categories","operationId":"pricing-category#create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestBody"},"example":{"pricing_category":{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"identifier":"abc123","services":[{"name":"abc123","service_prices":[{"kind":"abc123","price":1,"tenure":1}]}]}}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingCategoryResult"},"example":{"pricing_category":{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","identifier":"abc123","services":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}]}}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-pricing-category:edit"]}]}},"/ops/pricing_categories/{id}":{"delete":{"tags":["ops"],"summary":"delete pricing-category","description":"Delete a pricing category","operationId":"pricing-category#delete","parameters":[{"name":"id","in":"path","description":"topi pricing category ID","required":true,"schema":{"type":"string","description":"topi pricing category ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-pricing-category:edit"]}]}},"/ops/pricing_categories/{id}/headrooms":{"put":{"tags":["ops"],"summary":"update_headrooms pricing-category","description":"update headrooms for an existing pricing category","operationId":"pricing-category#update_headrooms","parameters":[{"name":"id","in":"path","description":"Pricing Category ID","required":true,"schema":{"type":"string","description":"Pricing Category ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHeadroomsRequestBody"},"example":{"headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingCategory"},"example":{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","identifier":"abc123","services":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-pricing-category:edit"]}]}},"/ops/pricing_categories/{id}/service_price":{"patch":{"tags":["ops"],"summary":"update_service_prices pricing-category","description":"update price of an existing service for an existing pricing category","operationId":"pricing-category#update_service_prices","parameters":[{"name":"id","in":"path","description":"Pricing Category ID","required":true,"schema":{"type":"string","description":"Pricing Category ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServicePricesRequestBody"},"example":{"service_prices":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","price":1}]}}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingCategory"},"example":{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","identifier":"abc123","services":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-pricing-category:edit"]}]}},"/ops/product_suggestions":{"post":{"tags":["ops"],"summary":"CreateProductSuggestion catalog","description":"create a product suggestion for a given product id","operationId":"catalog#CreateProductSuggestion","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSuggestionPayload"},"example":{"product_id":"abc123","seller_id":"abc123","suggestion_weight":1}}}},"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/product_suggestions/seller/{seller_id}":{"get":{"tags":["ops"],"summary":"ListProductSuggestionsForSeller catalog","description":"show all product suggestions for a seller","operationId":"catalog#ListProductSuggestionsForSeller","parameters":[{"name":"seller_id","in":"path","description":"seller id","required":true,"schema":{"type":"string","description":"seller id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductSuggestion"},"example":[{"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"abc123","subtitle":"abc123","suggestion_weight":1,"title":"abc123"}]},"example":[{"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"abc123","subtitle":"abc123","suggestion_weight":1,"title":"abc123"}]}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]}},"/ops/product_suggestions/{product_id}":{"delete":{"tags":["ops"],"summary":"RemoveProductSuggestion catalog","description":"delete a product suggestion for a given product id","operationId":"catalog#RemoveProductSuggestion","parameters":[{"name":"product_id","in":"path","description":"product id","required":true,"schema":{"type":"string","description":"product id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]},"get":{"tags":["ops"],"summary":"ShowProductSuggestion catalog","description":"show a product suggestion for a given product id","operationId":"catalog#ShowProductSuggestion","parameters":[{"name":"product_id","in":"path","description":"product id","required":true,"schema":{"type":"string","description":"product id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSuggestion"},"example":{"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"abc123","subtitle":"abc123","suggestion_weight":1,"title":"abc123"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]},"patch":{"tags":["ops"],"summary":"UpdateProductSuggestion catalog","description":"update a product suggestion for a given product id","operationId":"catalog#UpdateProductSuggestion","parameters":[{"name":"product_id","in":"path","description":"product id","required":true,"schema":{"type":"string","description":"product id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductSuggestion"},"example":{"suggestion_weight":1}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/reminder":{"get":{"tags":["ops"],"summary":"getAllReminders reminder","description":"get all reminders for OPS","operationId":"reminder#getAllReminders","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reminders"},"example":{"values":[{"current_step_id":"abc123","id":"abc123","last_run_at":"1970-01-01T00:00:01Z","next_run_at":"1970-01-01T00:00:01Z","reminder_type":"abc123","run_count":1,"user_id":"abc123"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["reminder:edit"]}]}},"/ops/reminder-policy":{"post":{"tags":["ops"],"summary":"createReminderPolicy reminder","description":"Create a reminder policy","operationId":"reminder#createReminderPolicy","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderPolicy"},"example":{"description":"abc123","reminder_type":"abc123","steps":[{"interval_days":1,"is_recurring":false,"step_number":1}]}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["reminder:edit"]}]}},"/ops/reminder/{id}/cancel":{"post":{"tags":["ops"],"summary":"cancelReminder reminder","description":"cancel a reminder","operationId":"reminder#cancelReminder","parameters":[{"name":"id","in":"path","description":"the ID of the reminder","required":true,"schema":{"type":"string","description":"the ID of the reminder","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["reminder:edit"]}]}},"/ops/sales-agents":{"get":{"tags":["ops"],"summary":"findAgents portal_sales_agents","description":"Get a list of all portal sales agents or sales agents for provided seller_id","operationId":"portal_sales_agents#findAgents","parameters":[{"name":"seller_id","in":"query","description":"Seller Id","allowEmptyValue":true,"schema":{"type":"string","description":"Seller Id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"exclude_suspended","in":"query","description":"Whether to exclude suspended sales agents","allowEmptyValue":true,"schema":{"type":"boolean","description":"Whether to exclude suspended sales agents","default":true,"example":false},"example":false}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSalesAgents"},"example":{"agents":[{"email":"alice@example.com","external_agent_id":"abc123","id":"auth0|63881a171828b3997ad1b3fc","language":"abc123","last_login":"1970-01-01T00:00:01Z","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123","status":"abc123","topi_relevant":false}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"SellerNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:read"]}]},"post":{"tags":["ops"],"summary":"addPortalAgent portal_sales_agents","description":"Add a new seller portal sales agent","operationId":"portal_sales_agents#addPortalAgent","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPortalAgent"},"example":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123","topi_relevant":false}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSalesAgent"},"example":{"email":"alice@example.com","external_agent_id":"abc123","id":"auth0|63881a171828b3997ad1b3fc","language":"abc123","last_login":"1970-01-01T00:00:01Z","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123","status":"abc123","topi_relevant":false}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"409":{"description":"EmailAlreadyExists: Conflict response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sales-agents/bulk":{"post":{"tags":["ops"],"summary":"addBulkAgents portal_sales_agents","description":"Add a bulk of sales agents to the seller portal","operationId":"portal_sales_agents#addBulkAgents","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBulkAgentsRequestBody"},"example":{"new_agents":[{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123"}]}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalBulkSummary"},"example":{"count_new_agents":1,"failed_agents":["abc123"]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"SellerNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sales-agents/invite-email":{"post":{"tags":["ops"],"summary":"InviteByEmail portal_sales_agents","description":"submits a request to invite user to login by email","operationId":"portal_sales_agents#InviteByEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteByEmailPayload"},"example":{"email":"abc123"}}}},"responses":{"202":{"description":"Accepted response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"AgentNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sales-agents/{id}":{"post":{"tags":["ops"],"summary":"updateAgent portal_sales_agents","description":"update sales agent information in Auth0","operationId":"portal_sales_agents#updateAgent","parameters":[{"name":"id","in":"path","description":"Auth0 Sales Agent ID","required":true,"schema":{"type":"string","description":"Auth0 Sales Agent ID","example":"auth0|63881a171828b3997ad1b3fc"},"example":"auth0|63881a171828b3997ad1b3fc"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentRequestBody"},"example":{"email":"alice@example.com","external_agent_id":"abc123","language":"abc123","last_login":"1970-01-01T00:00:01Z","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123","status":"abc123","topi_relevant":false}}}},"responses":{"202":{"description":"Accepted response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"AgentNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sales-agents/{id}/invite":{"put":{"tags":["ops"],"summary":"inviteToLogin portal_sales_agents","description":"submits a request to invite user to login","operationId":"portal_sales_agents#inviteToLogin","parameters":[{"name":"id","in":"path","description":"Auth0 Sales Agent ID","required":true,"schema":{"type":"string","description":"Auth0 Sales Agent ID","example":"auth0|63881a171828b3997ad1b3fc"},"example":"auth0|63881a171828b3997ad1b3fc"}],"responses":{"202":{"description":"Accepted response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"AgentNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sales-agents/{id}/link":{"put":{"tags":["ops"],"summary":"linkAgent portal_sales_agents","description":"Link a sales agent to a seller in Auth0","operationId":"portal_sales_agents#linkAgent","parameters":[{"name":"id","in":"path","description":"Auth0 Sales Agent ID","required":true,"schema":{"type":"string","description":"Auth0 Sales Agent ID","example":"auth0|63881a171828b3997ad1b3fc"},"example":"auth0|63881a171828b3997ad1b3fc"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerPayload"},"example":{"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"202":{"description":"Accepted response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"AgentNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sales-agents/{id}/suspend":{"put":{"tags":["ops"],"summary":"suspendAgent portal_sales_agents","description":"Suspends a portal user and prevents them from login","operationId":"portal_sales_agents#suspendAgent","parameters":[{"name":"id","in":"path","description":"Auth0 Sales Agent ID","required":true,"schema":{"type":"string","description":"Auth0 Sales Agent ID","example":"auth0|63881a171828b3997ad1b3fc"},"example":"auth0|63881a171828b3997ad1b3fc"}],"responses":{"202":{"description":"Accepted response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"AgentNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sales-agents/{id}/unlink":{"put":{"tags":["ops"],"summary":"unlinkAgent portal_sales_agents","description":"Unlink a sales agent to a seller","operationId":"portal_sales_agents#unlinkAgent","parameters":[{"name":"id","in":"path","description":"Auth0 Sales Agent ID","required":true,"schema":{"type":"string","description":"Auth0 Sales Agent ID","example":"auth0|63881a171828b3997ad1b3fc"},"example":"auth0|63881a171828b3997ad1b3fc"}],"responses":{"202":{"description":"Accepted response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"AgentNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sales-agents/{id}/unsuspend":{"put":{"tags":["ops"],"summary":"unsuspendAgent portal_sales_agents","description":"Unsuspend a portal user and prevents them from login","operationId":"portal_sales_agents#unsuspendAgent","parameters":[{"name":"id","in":"path","description":"Auth0 Sales Agent ID","required":true,"schema":{"type":"string","description":"Auth0 Sales Agent ID","example":"auth0|63881a171828b3997ad1b3fc"},"example":"auth0|63881a171828b3997ad1b3fc"}],"responses":{"202":{"description":"Accepted response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"AgentNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers":{"get":{"tags":["ops"],"summary":"getSellers seller","description":"get a list with all sellers","operationId":"seller#getSellers","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sellers"},"example":{"sellers":[{"address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"can_provide_serial_numbers":false,"can_use_parent_catalog":false,"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_email_end_customer_on_offer_created":false,"capability_hide_buy_now":false,"capability_international_shipment":false,"capability_show_ecom_orders":false,"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false,"central_catalog":false,"currency":"abc123","email":"abc123","erp_integrated":false,"external_contractual_entity":{"contractual_entity":"abc123","external_id":"abc123","id":"abc123","risk_status":"approved","status_changed_at":"1970-01-01T00:00:01Z"},"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kickback_ratio":1,"logo_url":"abc123","name":"abc123","parent_seller_id":"abc123","pdf_reader_assistant_id":"abc123","pretty_name":"abc123","product_reference_source":"abc123","widget_id":"abc123"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:read"]}]},"post":{"tags":["ops"],"summary":"addSeller seller","description":"Add a new seller","operationId":"seller#addSeller","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSellerPayload"},"example":{"address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"can_provide_serial_numbers":false,"can_use_parent_catalog":false,"capability_add_custom_products":false,"capability_anonymized_pricing":false,"capability_anonymous_ecom_offer_creation":false,"capability_bundles":false,"capability_central_catalog":false,"capability_chatbot_id":"abc123","capability_dual_pricing":false,"capability_email_end_customer_on_offer_created":false,"capability_hide_buy_now":false,"capability_international_shipment":false,"capability_show_ecom_orders":false,"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false,"currency":"EUR","email":"email@domain.com","erp_integrated":false,"external_contractual_entity":"abc123","external_id":"abc123","kickback_ratio":1,"logo_url":"abc123","name":"aa","parent_seller_id":"abc123","pdf_reader_assistant_id":"abc123","pretty_name":"aa","product_reference_source":"aa","risk_status":"approved","shipping_method_name":"abc123","shipping_method_seller_reference":"abc123","status_changed_at":"1970-01-01T00:00:01Z"}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpsSellerInfo"},"example":{"address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"can_provide_serial_numbers":false,"can_use_parent_catalog":false,"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_email_end_customer_on_offer_created":false,"capability_hide_buy_now":false,"capability_international_shipment":false,"capability_show_ecom_orders":false,"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false,"central_catalog":false,"currency":"abc123","email":"abc123","erp_integrated":false,"external_contractual_entity":{"contractual_entity":"abc123","external_id":"abc123","id":"abc123","risk_status":"approved","status_changed_at":"1970-01-01T00:00:01Z"},"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kickback_ratio":1,"logo_url":"abc123","name":"abc123","parent_seller_id":"abc123","pdf_reader_assistant_id":"abc123","pretty_name":"abc123","product_reference_source":"abc123","widget_id":"abc123"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/access":{"get":{"tags":["ops"],"summary":"getSellerAccesses seller","description":"get a list with all seller accesses","operationId":"seller#getSellerAccesses","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccessResults"},"example":{"sellerAccesses":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_catalog_provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:read"]}]},"post":{"tags":["ops"],"summary":"addSellerAccess seller","description":"Add a new seller access","operationId":"seller#addSellerAccess","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccess"},"example":{"seller_catalog_provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccessResult"},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_catalog_provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/access/{seller_id}/provider/{seller_catalog_provider_id}":{"delete":{"tags":["ops"],"summary":"removeSellerAccess seller","description":"Remove seller access","operationId":"seller#removeSellerAccess","parameters":[{"name":"seller_id","in":"path","required":true,"schema":{"type":"string","example":"abc123"},"example":"abc123"},{"name":"seller_catalog_provider_id","in":"path","required":true,"schema":{"type":"string","example":"abc123"},"example":"abc123"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/reenable/{seller_id}":{"post":{"tags":["ops"],"summary":"reEnableSeller seller","description":"Reenable a removed seller","operationId":"seller#reEnableSeller","parameters":[{"name":"seller_id","in":"path","required":true,"schema":{"type":"string","example":"abc123"},"example":"abc123"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/update-logo":{"post":{"tags":["ops"],"summary":"updateLogo seller","description":"Add logo to existing seller","operationId":"seller#updateLogo","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSellerLogoPayload"},"example":{"logo_image":"abc123","mime_type":"abc123","seller_id":"abc123"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/upload-logo":{"post":{"tags":["ops"],"summary":"uploadLogo seller","description":"Add logo to logo bucket","operationId":"seller#uploadLogo","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadLogoPayload"},"example":{"logo_image":"abc123","mime_type":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"string","description":"The url of the uploaded logo","example":"abc123"},"example":"abc123"}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/{id}":{"delete":{"tags":["ops"],"summary":"removeSeller seller","description":"Remove a seller","operationId":"seller#removeSeller","parameters":[{"name":"name","in":"query","description":"The name of the seller","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"The name of the seller","example":"abc123"},"example":"abc123"},{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"abc123"},"example":"abc123"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]},"put":{"tags":["ops"],"summary":"updateSeller seller","description":"Update a seller","operationId":"seller#updateSeller","parameters":[{"name":"id","in":"path","description":"Seller Id","required":true,"schema":{"type":"string","description":"Seller Id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSellerPayload"},"example":{"address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"can_provide_serial_numbers":false,"can_use_parent_catalog":false,"capability_add_custom_products":false,"capability_anonymized_pricing":false,"capability_anonymous_ecom_offer_creation":false,"capability_bundles":false,"capability_central_catalog":false,"capability_chatbot_id":"abc123","capability_dual_pricing":false,"capability_email_end_customer_on_offer_created":false,"capability_hide_buy_now":false,"capability_international_shipment":false,"capability_show_ecom_orders":false,"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false,"email":"aa","erp_integrated":false,"external_contractual_entity":"abc123","external_id":"abc123","kickback_ratio":1,"logo_url":"abc123","name":"aa","parent_seller_id":"abc123","pdf_reader_assistant_id":"abc123","pretty_name":"aa","product_reference_source":"aa","risk_status":"approved","shipping_method_name":"abc123","shipping_method_seller_reference":"abc123","status_changed_at":"1970-01-01T00:00:01Z","widget_id":"abc123"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/{id}/oauth":{"get":{"tags":["ops"],"summary":"list seller_oauth","description":"List all OAuth clients for a seller","operationId":"seller_oauth#list","parameters":[{"name":"id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerOAuthClients"},"example":{"clients":[{"client_id":"abc123","created_at":"1970-01-01T00:00:01Z","name":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","updated_at":"1970-01-01T00:00:01Z"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"SellerNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:read"]}]},"post":{"tags":["ops"],"summary":"create seller_oauth","description":"Create a new OAuth client for a seller","operationId":"seller_oauth#create","parameters":[{"name":"id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestBody2"},"example":{"mode":"live","name":"Production API Access"}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerOAuthClientCreate"},"example":{"client_id":"abc123","client_secret":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6","name":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"SellerNotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/{id}/oauth/{client_id}":{"delete":{"tags":["ops"],"summary":"delete seller_oauth","description":"Delete an OAuth client","operationId":"seller_oauth#delete","parameters":[{"name":"id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"client_id","in":"path","description":"OAuth client ID","required":true,"schema":{"type":"string","description":"OAuth client ID","example":"live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"},"example":"live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"}],"responses":{"204":{"description":"No Content response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/{id}/webhook":{"post":{"tags":["ops"],"summary":"addWebhook seller","description":"Register a new url to this seller","operationId":"seller#addWebhook","parameters":[{"name":"id","in":"path","description":"Seller Id","required":true,"schema":{"type":"string","description":"Seller Id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddWebhookPayload"},"example":{"channels":["order"],"url":"abc123"}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerWebhookUrls"},"example":{"urls":["https://example.com/foo"]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/{id}/webhook-portal":{"get":{"tags":["ops"],"summary":"getWebhookPortalLink seller","description":"Get webhook portal link for a seller","operationId":"seller#getWebhookPortalLink","parameters":[{"name":"id","in":"path","description":"Seller Id","required":true,"schema":{"type":"string","description":"Seller Id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"string","description":"The URL to access the webhook portal","example":"abc123"},"example":"abc123"}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:read"]}]}},"/ops/sellers/{id}/widgets":{"post":{"tags":["ops"],"summary":"generateWidgetId seller","description":"Generates a new widget ID and sets it for the supplied seller","operationId":"seller#generateWidgetId","parameters":[{"name":"id","in":"path","description":"Seller Id","required":true,"schema":{"type":"string","description":"Seller Id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerWidgetInfo"},"example":{"seller_id":"abc123","widget_id":"abc123"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-seller:edit"]}]}},"/ops/sellers/{seller_id}/catalog":{"delete":{"tags":["ops"],"summary":"removeCatalog catalog","description":"Remove all the catalog for a seller. Danger! use only for testing in staging.Only works if seller doesn't have offers created","operationId":"catalog#removeCatalog","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/categorize":{"post":{"tags":["ops"],"summary":"CategorizeProducts catalog","description":"For the given product IDs, categorize them automatically with AI (open AI ChatGPT) For categorizing all seller products (that are not categorized) send an empty list for ids","operationId":"catalog#CategorizeProducts","parameters":[{"name":"batch_size","in":"query","description":"number of products per batch to be sent to openAI","allowEmptyValue":true,"schema":{"type":"integer","description":"number of products per batch to be sent to openAI","default":40,"example":1,"format":"int64"},"example":1},{"name":"num_workers","in":"query","description":"number of workers to use for processing product batches","allowEmptyValue":true,"schema":{"type":"integer","description":"number of workers to use for processing product batches","default":10,"example":2,"format":"int64","minimum":1},"example":2},{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductIDList"},"example":{"ids":["abc123"]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizeProductsResponseBody"},"example":{"result":{"errors":["abc123"],"total_categorized":1,"total_errors":1,"total_products":1}}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"503":{"description":"CategorizeAPIError: Service Unavailable response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/categorize/pending":{"post":{"tags":["ops"],"summary":"CategorizePendingProducts catalog","description":"For a seller invoke the queue that categorize the product for a seller, we should do it when the categorize system was down by any reason","operationId":"catalog#CategorizePendingProducts","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/export":{"get":{"tags":["ops"],"summary":"downloadProducts catalog","description":"Download products from a catalog","operationId":"catalog#downloadProducts","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","headers":{"Content-Length":{"description":"...","schema":{"type":"integer","description":"...","example":1,"format":"int64"},"example":1}},"content":{"text/csv":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]}},"/ops/sellers/{seller_id}/catalog/import":{"post":{"tags":["ops"],"summary":"importProducts catalog","description":"Add a batch of products to the catalog","operationId":"catalog#importProducts","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportProductsRequestBody"},"example":{"products":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"image":{"url":"https://example.com/foo"},"is_active":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"},{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"image":{"url":"https://example.com/foo"},"is_active":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportResult"},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","status":"started","summary":{"sample_products_rejected":[{"error_code":"abc123","error_description":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"}}],"total_products":1,"total_products_imported":1,"total_products_rejected":1}}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":"abc123"}}},"413":{"description":"TooManyProducts: Request Entity Too Large response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/imports":{"post":{"tags":["ops"],"summary":"opsCreateImport catalog","description":"Create a new CSV import job for a seller.","operationId":"catalog#opsCreateImport","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpsCreateImportRequestBody"},"example":{"filename":"abc123"}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpsCatalogCreateImportResult"},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","upload_url":"https://example.com/foo"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"429":{"description":"TooManyRequests: Too Many Requests response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/imports/{id}":{"delete":{"tags":["ops"],"summary":"opsCancelImport catalog","description":"Cancel a CSV import job for a seller.","operationId":"catalog#opsCancelImport","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"id","in":"path","description":"The import job ID to cancel.","required":true,"schema":{"type":"string","description":"The import job ID to cancel.","example":"550e8400-e29b-41d4-a716-446655440000","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]},"get":{"tags":["ops"],"summary":"opsGetImport catalog","description":"Get CSV import job details for a seller.","operationId":"catalog#opsGetImport","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"id","in":"path","description":"The import job ID.","required":true,"schema":{"type":"string","description":"The import job ID.","example":"550e8400-e29b-41d4-a716-446655440000","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpsCatalogImportJob"},"example":{"categorization":{"done":false,"pending":1,"supported":1,"to_be_reviewed":1,"total":1,"unsupported":1},"created_at":"1970-01-01T00:00:01Z","error":"abc123","errors_url":"https://example.com/foo","failed":1,"filename":"abc123","id":"739b63c2-9e58-4964-b38d-4ebb424de242","object_path":"https://example.com/foo","processed":1,"status":"queued","succeeded":1,"updated_at":"1970-01-01T00:00:01Z"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]}},"/ops/sellers/{seller_id}/catalog/pricing_categories":{"patch":{"tags":["ops"],"summary":"updatePricingCategories catalog","description":"Update pricing categories of products in a batch operation","operationId":"catalog#updatePricingCategories","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePricingCategoriesRequestBody"},"example":{"pricing_category_updates":[{"pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductIDList"},"example":{"ids":["abc123"]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/products":{"get":{"tags":["ops"],"summary":"list catalog","description":"Fetch all products in the catalog","operationId":"catalog#list","parameters":[{"name":"page","in":"query","description":"Which page number to fetch (zero-indexed)","allowEmptyValue":true,"schema":{"type":"integer","description":"Which page number to fetch (zero-indexed)","default":0,"example":0,"format":"int64"},"example":0},{"name":"starting_after","in":"query","description":"A cursor to use in pagination. It will be the starting point of the list and will not be included in the results.","allowEmptyValue":true,"schema":{"type":"string","description":"A cursor to use in pagination. It will be the starting point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"ending_before","in":"query","description":"A cursor to use in pagination. It will be the ending point of the list and will not be included in the results.","allowEmptyValue":true,"schema":{"type":"string","description":"A cursor to use in pagination. It will be the ending point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"limit","in":"query","description":"How many results to return per page.","allowEmptyValue":true,"schema":{"type":"integer","description":"How many results to return per page.","default":0,"example":10,"format":"int64","minimum":0},"example":10},{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProduct"},"example":{"data":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}],"pagination":{"has_more":false}}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]},"post":{"tags":["ops"],"summary":"createProduct catalog","description":"Add product to the catalog","operationId":"catalog#createProduct","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductRequestBody"},"example":{"product":{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"image":{"url":"https://example.com/foo"},"is_active":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"},"example":{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/products/finish-review":{"patch":{"tags":["ops"],"summary":"finishReview catalog","description":"Mark products meant for purchase only as fully reviewed","operationId":"catalog#finishReview","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDList"},"example":{"ids":["abc123"]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDList"},"example":{"ids":["abc123"]}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/products/review":{"get":{"tags":["ops"],"summary":"listToBeReviewed catalog","description":"Fetch all products in the catalog for a given seller that need to be reviewed by ops","operationId":"catalog#listToBeReviewed","parameters":[{"name":"page","in":"query","description":"Which page number to fetch (zero-indexed)","allowEmptyValue":true,"schema":{"type":"integer","description":"Which page number to fetch (zero-indexed)","default":0,"example":0,"format":"int64"},"example":0},{"name":"starting_after","in":"query","description":"A cursor to use in pagination. It will be the starting point of the list and will not be included in the results.","allowEmptyValue":true,"schema":{"type":"string","description":"A cursor to use in pagination. It will be the starting point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"ending_before","in":"query","description":"A cursor to use in pagination. It will be the ending point of the list and will not be included in the results.","allowEmptyValue":true,"schema":{"type":"string","description":"A cursor to use in pagination. It will be the ending point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"limit","in":"query","description":"How many results to return per page.","allowEmptyValue":true,"schema":{"type":"integer","description":"How many results to return per page.","default":0,"example":10,"format":"int64","minimum":0},"example":10},{"name":"review_status","in":"query","description":"Filter by review status","allowEmptyValue":true,"schema":{"type":"string","example":"unsupported","enum":["supported","unsupported","to_be_reviewed"]},"example":"unsupported"},{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProduct"},"example":{"data":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}],"pagination":{"has_more":false}}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]}},"/ops/sellers/{seller_id}/catalog/products/search":{"get":{"tags":["ops"],"summary":"search catalog","description":"Fetch products that match the search query","operationId":"catalog#search","parameters":[{"name":"query","in":"query","description":"Query for searching","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Query for searching","example":"aaa","minLength":3},"example":"aaa"},{"name":"limit","in":"query","description":"max amount of products to return","allowEmptyValue":true,"schema":{"type":"integer","description":"max amount of products to return","example":1,"format":"int64"},"example":1},{"name":"page","in":"query","description":"which page of the results to return","allowEmptyValue":true,"schema":{"type":"integer","description":"which page of the results to return","example":1,"format":"int64"},"example":1},{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"example":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}]},"example":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}]}}},"400":{"description":"empty_query: Query should not be empty value","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]}},"/ops/sellers/{seller_id}/catalog/products/set_is_active":{"patch":{"tags":["ops"],"summary":"set_is_active catalog","description":"Patch the is_active of products","operationId":"catalog#set_is_active","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetIsActiveRequestBody"},"example":{"ids":["abc123"],"is_active":false}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDList"},"example":{"ids":["abc123"]}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/products/supported":{"patch":{"tags":["ops"],"summary":"supported catalog","description":"Mark the given products as supported","operationId":"catalog#supported","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDList"},"example":{"ids":["abc123"]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDList"},"example":{"ids":["abc123"]}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/products/unsupported":{"patch":{"tags":["ops"],"summary":"unsupported catalog","description":"Mark as unsupported a product","operationId":"catalog#unsupported","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDList"},"example":{"ids":["abc123"]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDList"},"example":{"ids":["abc123"]}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/products/{id}":{"get":{"tags":["ops"],"summary":"show catalog","description":"Fetch a single product from the catalog","operationId":"catalog#show","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"id","in":"path","description":"topi Product ID","required":true,"schema":{"type":"string","description":"topi Product ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"},"example":{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]}},"/ops/sellers/{seller_id}/catalog/products_filtered":{"post":{"tags":["ops"],"summary":"listFiltered catalog","description":"Fetch and filter all products in the catalog","operationId":"catalog#listFiltered","parameters":[{"name":"page","in":"query","description":"Which page number to fetch (zero-indexed)","allowEmptyValue":true,"schema":{"type":"integer","description":"Which page number to fetch (zero-indexed)","default":0,"example":0,"format":"int64"},"example":0},{"name":"starting_after","in":"query","description":"A cursor to use in pagination. It will be the starting point of the list and will not be included in the results.","allowEmptyValue":true,"schema":{"type":"string","description":"A cursor to use in pagination. It will be the starting point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"ending_before","in":"query","description":"A cursor to use in pagination. It will be the ending point of the list and will not be included in the results.","allowEmptyValue":true,"schema":{"type":"string","description":"A cursor to use in pagination. It will be the ending point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"},{"name":"limit","in":"query","description":"How many results to return per page.","allowEmptyValue":true,"schema":{"type":"integer","description":"How many results to return per page.","default":0,"example":10,"format":"int64","minimum":0},"example":10},{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFilteredRequestBody"},"example":{"filteringOptions":[{"operation":"\u003e","property":"abc123","value":"abc123"}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilteredProductResult"},"example":{"FilteringErrors":"abc123","data":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}],"pagination":{"has_more":false}}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]}},"/ops/sellers/{seller_id}/catalog/reset-categorized":{"post":{"tags":["ops"],"summary":"ResetCategorizedProducts catalog","description":"Resets the pricing category for all products for the given seller. Products with the legacy categories legacy_phone_24 and legacy_laptop_36are ignored","operationId":"catalog#ResetCategorizedProducts","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetCategorizedProductsResponseBody"},"example":{"total":1}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/catalog/review":{"get":{"tags":["ops"],"summary":"reviewCatalog catalog","description":"Fetch paginated products pending review for a seller, including their AI categorization suggestions","operationId":"catalog#reviewCatalog","parameters":[{"name":"limit","in":"query","description":"the size of the page, capped at 100","allowEmptyValue":true,"schema":{"type":"integer","description":"the size of the page, capped at 100","example":20,"format":"int64"},"example":20},{"name":"page","in":"query","description":"the index of the page, zero-based","allowEmptyValue":true,"schema":{"type":"integer","description":"the index of the page, zero-based","example":0,"format":"int64"},"example":0},{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewCatalogResult"},"example":{"data":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}],"pagination":{"page":1,"page_size":1,"total_count":1,"total_pages":1}}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:read"]}]}},"/ops/sellers/{seller_id}/catalog/updateCustomProducts":{"put":{"tags":["ops"],"summary":"UpdateCustomProducts catalog","description":"Update a batch of products in the catalog","operationId":"catalog#UpdateCustomProducts","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomProductsRequestBody"},"example":{"products":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"},{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}]}}}},"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["catalog:edit"]}]}},"/ops/sellers/{seller_id}/orders/products/duplicate_ooc_references_to_default_source":{"patch":{"tags":["ops"],"summary":"CorrectCustomProductReferencesToDefaultSource order","description":"Use to fix OOC products if the default source of the seller changes","operationId":"order#CorrectCustomProductReferencesToDefaultSource","parameters":[{"name":"seller_id","in":"path","description":"Seller ID","required":true,"schema":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:edit"]}]}},"/ops/shipment":{"post":{"tags":["ops"],"summary":"createShipment order","description":"Add shipment info to an existing order.","operationId":"order#createShipment","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShipmentRequestBody"},"example":{"order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"abc123","serial_numbers":[{"asset_id":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"},"serial_number":"BA-3456786-334-9","tracking_url":"abc123"}]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"},"example":{"seller_id":"abc123","serial_numbers":[{"asset_id":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"},"serial_number":"BA-3456786-334-9","tracking_url":"abc123"}]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-order:edit"]}]}},"/ops/shipping-method":{"get":{"tags":["ops"],"summary":"getShippingMethodsOps shipping-method-ops","description":"Fetch all the shipping methods of the sellers","operationId":"shipping-method-ops#getShippingMethodsOps","parameters":[{"name":"page","in":"query","description":"Which page number to fetch (zero-indexed)","allowEmptyValue":true,"schema":{"type":"integer","description":"Which page number to fetch (zero-indexed)","default":0,"example":0,"format":"int64"},"example":0}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedShippingMethodOpsResult"},"example":{"data":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","is_in_store_pickup":false,"name":"abc123","review_status":"unsupported","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_shipping_method_reference":"Sandbox Shipping Service"}],"pagination":{"has_more":false,"page":0}}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-shipping-method:read"]}]},"post":{"tags":["ops"],"summary":"create shipping-method-ops","description":"Create a new shipping method for a seller","operationId":"shipping-method-ops#create","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShippingMethodPayload"},"example":{"is_in_store_pickup":false,"name":"United Parcel Service","seller_id":"gravis","seller_shipping_method_reference":"Sandbox Shipping Service"}}}},"responses":{"201":{"description":"Created response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingMethodOpsResult"},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","is_in_store_pickup":false,"name":"abc123","review_status":"unsupported","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_shipping_method_reference":"Sandbox Shipping Service"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-shipping-method:edit"]}]}},"/ops/shipping-method/supported":{"patch":{"tags":["ops"],"summary":"supported shipping-method-ops","description":"Mark the given shipping methods as supported","operationId":"shipping-method-ops#supported","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDList"},"example":{"ids":["abc123"]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDListShippingMethod"},"example":{"ids":["abc123"]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-shipping-method:edit"]}]}},"/ops/shipping-method/unsupported":{"patch":{"tags":["ops"],"summary":"unsupported shipping-method-ops","description":"Mark the given shipping methods as unsupported","operationId":"shipping-method-ops#unsupported","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDList"},"example":{"ids":["abc123"]}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IDListShippingMethod"},"example":{"ids":["abc123"]}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-shipping-method:edit"]}]}},"/ops/shipping-method/{id}/is-in-store-pickup":{"patch":{"tags":["ops"],"summary":"isInStorePickup shipping-method-ops","description":"Set the given shipping method isInStorePickup column","operationId":"shipping-method-ops#isInStorePickup","parameters":[{"name":"id","in":"path","description":"topi offer ID","required":true,"schema":{"type":"string","description":"topi offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsInStorePickupRequestBody"},"example":{"isInStorePickup":false}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingMethodOpsResult"},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","is_in_store_pickup":false,"name":"abc123","review_status":"unsupported","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_shipping_method_reference":"Sandbox Shipping Service"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-shipping-method:edit"]}]}},"/ops/trade-ins":{"get":{"tags":["ops"],"summary":"showAllTradeInsOps Trade in","description":"Fetch all trade ins by OPS","operationId":"Trade in#showAllTradeInsOps","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TradeInsListResult"},"example":{"tradeIns":[{"asset_grade":"abc123","asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","company_name":"abc123","estimated_residual_amount":{"currency":"EUR","gross":119000,"net":100000},"finalised_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","started_at":"1970-01-01T00:00:01Z","status":"abc123","tenure":1,"trade_in_id":"abc123","trade_in_price_amount":{"currency":"EUR","gross":119000,"net":100000},"trade_in_product_id":"abc123","user_email":"alice@example.com"}]}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-trade-in:read"]}]}},"/ops/trade-ins/check-email":{"post":{"tags":["ops"],"summary":"checkEmailToStartTradeInProcessOps Trade in","description":"Check if the user email is attached to the asset to start the trade in process requested by Ops","operationId":"Trade in#checkEmailToStartTradeInProcessOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckEmailTradeInProcessOpsPayload"},"example":{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","user_email":"alice@example.com"}}}},"responses":{"200":{"description":"OK response."},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"ServiceUnavailable: Service Unavailable response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-trade-in:edit"]}]}},"/ops/trade-ins/fetch-update":{"put":{"tags":["ops"],"summary":"fetchAndUpdateTradeInInfoOps Trade in","description":"Fetch trade in update by OPS","operationId":"Trade in#fetchAndUpdateTradeInInfoOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchAndUpdateTradeInInfoOpsPayload"},"example":{"id":"abc123","trade_in_id":"abc123","trade_in_product_id":"abc123"}}}},"responses":{"200":{"description":"OK response."}},"security":[{"OAuth2Topi_header_Authorization":["ops-trade-in:edit"]}]}},"/ops/trade-ins/ingest-by-product-ids":{"post":{"tags":["ops"],"summary":"ingestByProductIDs Trade in","description":"Ingest by product IDs from a CSV file","operationId":"Trade in#ingestByProductIDs","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestByProductIDsPayload"},"example":{"csv_import":"abc123","provider_id":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestByProductIDsResult"},"example":{"failed_count":1,"failed_items":[{"line_number":1,"reason":"abc123"}],"skipped_count":1,"skipped_items":[{"line_number":1,"reason":"abc123"}],"succeeded_count":1,"total_count":1}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-trade-in:edit"]}]}},"/ops/trade-ins/start":{"post":{"tags":["ops"],"summary":"startTradeInProcessOps Trade in","description":"Start trade in process requested by Ops","operationId":"Trade in#startTradeInProcessOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartOpsTradeInProcessPayload"},"example":{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","contract_start_date":"1970-01-01T00:00:01Z","override_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"trade_in_type":"abc123","user_email":"alice@example.com"}}}},"responses":{"200":{"description":"OK response."},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"ServiceUnavailable: Service Unavailable response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-trade-in:edit"]}]}},"/ops/users":{"get":{"tags":["ops"],"summary":"listUsers user","description":"list all our users","operationId":"user#listUsers","parameters":[{"name":"email","in":"query","description":"filter users by email","allowEmptyValue":true,"schema":{"type":"string","description":"filter users by email","example":"abc123"},"example":"abc123"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserSummaryForOps"},"example":[{"created_at":"1970-01-01T00:00:01Z","email":"abc123","email_verified":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","marketing_accepted":false,"terms_accepted":false,"terms_accepted_at":"1970-01-01T00:00:01Z"}]},"example":[{"created_at":"1970-01-01T00:00:01Z","email":"abc123","email_verified":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","marketing_accepted":false,"terms_accepted":false,"terms_accepted_at":"1970-01-01T00:00:01Z"}]}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-user:read"]}]},"post":{"tags":["ops"],"summary":"addUser user","description":"add user as an ops","operationId":"user#addUser","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddUserPayload"},"example":{"email":"abc123","email_lang":"en","first_name":"abc123","last_name":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSummaryForOps"},"example":{"created_at":"1970-01-01T00:00:01Z","email":"abc123","email_verified":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","marketing_accepted":false,"terms_accepted":false,"terms_accepted_at":"1970-01-01T00:00:01Z"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-user:edit"]}]}},"/ops/users/notify":{"post":{"tags":["ops"],"summary":"notifyUsersByEmailOps user","description":"sends a notification by email to a list of users","operationId":"user#notifyUsersByEmailOps","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotifyUsersByEmailPayload"},"example":{"email_list":["abc123"],"language":"en","template_name":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotifyUsersByEmailResult"},"example":{"failed_count":1,"failed_emails":["abc123"],"succeeded_count":1,"total_count":1}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"503":{"description":"ServiceUnavailable: Service Unavailable response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-user:read"]}]}},"/ops/users/send-test-email":{"post":{"tags":["ops"],"summary":"sendTestEmail user","description":"send a test email to a specified user's email as if it were from a specific seller","operationId":"user#sendTestEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTestEmailRequestBody"},"example":{"email":"abc123","seller_id":"abc123"}}}},"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-user:read"]}]}},"/ops/users/update-email":{"post":{"tags":["ops"],"summary":"updateEmail user","description":"update user email","operationId":"user#updateEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailRequestBody"},"example":{"current_email":"alice@example.com","new_email":"alice@example.com"}}}},"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: cannot find user with the given email","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-user:edit"]}]}},"/ops/users/{id}/delete":{"delete":{"tags":["ops"],"summary":"deleteUser user","description":"delete user by email","operationId":"user#deleteUser","parameters":[{"name":"id","in":"path","description":"User ID","required":true,"schema":{"type":"string","description":"User ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUserRequestBody"},"example":{"user_email":"alice@example.com"}}}},"responses":{"200":{"description":"OK response."},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: cannot find user with the given email","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["ops-user:edit"]}]}},"/payment_method":{"get":{"tags":["payment-method"],"summary":"getPaymentMethod payment-method","description":"get the configured payment method","operationId":"payment-method#getPaymentMethod","parameters":[{"name":"psp_payment_method_id","in":"query","description":"Payment method ID from the PSP","allowEmptyValue":true,"schema":{"type":"string","description":"Payment method ID from the PSP","example":"abc123"},"example":"abc123"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"},"example":{"account_holder_name":"abc123","account_number_ending":"abc123","bank_name":"abc123","country_code":"abc123","provider":"stripe_asset_gmbh","type":"abc123"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"OAuth2Topi_header_Authorization":["payment_method:edit"]}]}},"/payment_method/end-customer-updated":{"post":{"tags":["payment-method"],"summary":"endCustomerUpdated payment-method","description":"Handle end-customer events from PubSub","operationId":"payment-method#endCustomerUpdated","parameters":[{"name":"token","in":"query","description":"Verification token sent as a query string","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Verification token sent as a query string","example":"abc123"},"example":"abc123"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PubSubPayload3"},"example":{"deliveryAttempt":1,"message":{"attributes":{"abc123":"abc123"},"data":"abc123","messageId":"abc123","orderingKey":"abc123","publishTime":"abc123"},"subscription":"abc123"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"jwt_header_Authorization":[]}]}},"/payment_method/setup-stripe-checkout-data":{"post":{"tags":["payment-method"],"summary":"setupStripeCheckoutData payment-method","description":"create the customer and retrieve the secret from Stripe to add the payment method","operationId":"payment-method#setupStripeCheckoutData","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StripeSetupIntentPayload"},"example":{"offer_id":"abc123","stripe_checkout_session_return_url":"abc123","use_stripe_checkout_session":false}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetupStripeCheckoutDataResponseBody"},"example":{"client_secret":"abc123","session_id":"abc123"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["payment_method:edit"]}]}},"/payment_method/updated":{"post":{"tags":["payment-method"],"summary":"paymentMethodUpdated payment-method","description":"Handle payment method update events from PubSub","operationId":"payment-method#paymentMethodUpdated","parameters":[{"name":"token","in":"query","description":"Verification token sent as a query string","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Verification token sent as a query string","example":"abc123"},"example":"abc123"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PubSubPayload2"},"example":{"deliveryAttempt":1,"message":{"attributes":{"abc123":"abc123"},"data":"abc123","messageId":"abc123","orderingKey":"abc123","publishTime":"abc123"},"subscription":"abc123"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"jwt_header_Authorization":[]}]}},"/rentalitem/events/termination":{"post":{"tags":["rental_item_events"],"summary":"handleTermination rental_item_events","description":"Handle rental item termination events from PubSub","operationId":"rental_item_events#handleTermination","parameters":[{"name":"token","in":"query","description":"Verification token sent as a query string","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Verification token sent as a query string","example":"abc123"},"example":"abc123"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PubSubPayload4"},"example":{"deliveryAttempt":1,"message":{"attributes":{"abc123":"abc123"},"data":"abc123","messageId":"abc123","orderingKey":"abc123","publishTime":"abc123"},"subscription":"abc123"}}}},"responses":{"200":{"description":"OK response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"jwt_header_Authorization":[]}]}},"/users/assign-end-customer":{"post":{"tags":["user"],"summary":"assignEndCustomer user","description":"Search for an existing End Customer or create a new one, then assign it to the user.","operationId":"user#assignEndCustomer","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomerMatcherPayload"},"example":{"company_name":"abc123","country_code":"abc123","offer_id":"abc123","type":"Partnership","vat_number":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomerWithUser"},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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,"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"}}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: cannot find user","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"ValidationError: Validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"errors":[{"code":"abc123","field":"abc123","message":"abc123"}],"message":"abc123"}}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:edit"]}]}},"/users/byOffer":{"get":{"tags":["user"],"summary":"userByOffer user","description":"Return basic info about the user attached to this offer","operationId":"user#userByOffer","parameters":[{"name":"token","in":"query","description":"the shared token","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"the shared token","example":"abc123"},"example":"abc123"},{"name":"offer_id","in":"query","description":"Offer ID","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymizedUser"},"example":{"email_hash":"abc123","email_verified":false,"end_customer_id":"abc123","has_end_customer_enroled":false,"has_user_enroled":false,"has_user_signed_up":false,"terms_accepted":false}}}},"400":{"description":"InvalidToken: shared token is invalid","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/users/end-customer-status":{"get":{"tags":["user"],"summary":"getEndCustomerStatus user","description":"get end customer status, e.g. some additional checks needed","operationId":"user#getEndCustomerStatus","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCustomerStatus"},"example":{"verification_required":false}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}},"security":[{"OAuth2Topi_header_Authorization":["offer:read"]}]}},"/users/resend-otp":{"post":{"tags":["user"],"summary":"resendOtp user","description":"resend otp token","operationId":"user#resendOtp","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendOtpPayload"},"example":{"offer_share_token":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtpConfirmationResponse"},"example":{"anonymized_email":"abc123","code":"abc123"}}}},"400":{"description":"InvalidToken: shared token is invalid","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}}}}},"/users/signUpWithOtp":{"post":{"tags":["user"],"summary":"signUpWithOtp user","description":"sign up as end costumer using an otp token","operationId":"user#signUpWithOtp","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignUpPayload"},"example":{"email":"abc123","marketing_accepted":false,"offer_share_token":"abc123"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtpConfirmationResponse"},"example":{"anonymized_email":"abc123","code":"abc123"}}}},"400":{"description":"InvalidToken: shared token is invalid","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/users/{id}":{"get":{"tags":["user"],"summary":"getUserByID user","description":"Get user by id","operationId":"user#getUserByID","parameters":[{"name":"id","in":"path","description":"User ID","required":true,"schema":{"type":"string","description":"User ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"example":"739b63c2-9e58-4964-b38d-4ebb424de242"}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWithEndCustomerID"},"example":{"end_customer_id":"abc123","user":{"created_at":"1970-01-01T00:00:01Z","email":"abc123","email_verified":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","marketing_accepted":false,"terms_accepted":false,"terms_accepted_at":"1970-01-01T00:00:01Z"}}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"403":{"description":"InvalidScopes: Forbidden response.","content":{"application/json":{"schema":{"type":"string","example":"abc123"},"example":"abc123"}}},"404":{"description":"NotFound: Not Found response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/waitlist/sign-up":{"post":{"tags":["waitlist"],"summary":"sign-up waitlist","description":"Sign-up for the waitlist","operationId":"waitlist#sign-up","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaitlistSignUpPayload"},"example":{"company_name":"aaa","email":"aaa","first_name":"aaa","last_name":"aaa","phone":"aaa","seller":"aaa"}}}},"responses":{"201":{"description":"Created response."},"400":{"description":"BadRequest: Bad Request response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable: Unprocessable Entity response.","content":{"application/vnd.goa.error":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"AcceptOfferPayload":{"type":"object","properties":{"discount_code":{"type":"string","description":"A valid discount code that should be applied to this offer","example":"abc123"},"id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"last_updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"discount_code":"abc123","id":"739b63c2-9e58-4964-b38d-4ebb424de242","last_updated_at":"1970-01-01T00:00:01Z"},"required":["id"]},"AcceptOpsRequestBody":{"type":"object","properties":{"discount_code":{"type":"string","description":"A valid discount code that should be applied to this offer","example":"abc123"},"email":{"type":"string","description":"Customer's email for this offer","example":"abc123"},"last_updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"}},"example":{"discount_code":"abc123","email":"abc123","last_updated_at":"1970-01-01T00:00:01Z","seller_offer_reference":"abc123"},"required":["seller_offer_reference","email"]},"AcceptRequestBody":{"type":"object","properties":{"discount_code":{"type":"string","description":"A valid discount code that should be applied to this offer","example":"abc123"},"last_updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"seon_session_token":{"type":"string","description":"The SEON session token","example":"abc123"}},"example":{"discount_code":"abc123","last_updated_at":"1970-01-01T00:00:01Z","seon_session_token":"abc123"}},"AddBranding":{"type":"object","properties":{"email_logo_url":{"type":"string","description":"Url for the logo to display in emails, if any","example":"abc123"},"enable_transactional_emails":{"type":"boolean","description":"Whether or not to enable transactional emails","example":false},"info_hub_url":{"type":"string","description":"Url for the info hub, if any","example":"abc123"},"logo_url":{"type":"string","description":"Url for the logo to display, if any","example":"abc123"},"name":{"type":"string","description":"Name of the branding config","example":"abc123"}},"example":{"email_logo_url":"abc123","enable_transactional_emails":false,"info_hub_url":"abc123","logo_url":"abc123","name":"abc123"},"required":["name","enable_transactional_emails"]},"AddBulkAgentsRequestBody":{"type":"object","properties":{"new_agents":{"type":"array","items":{"$ref":"#/components/schemas/CommonPortalAgent"},"description":"List con agents to add.","example":[{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123"}]}},"example":{"new_agents":[{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123"}]}},"AddContractTermsOpsRequestBody":{"type":"object","properties":{"offer_line_contract_terms":{"type":"array","items":{"$ref":"#/components/schemas/ContractTermsByOfferLine"},"example":[{"contract_terms":{"contract_terms":[{"payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}],"default_contract_term":{"duration":6},"rent":{"duration":6,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}},"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","replace_all":false}]},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"offer_line_contract_terms":[{"contract_terms":{"contract_terms":[{"payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}],"default_contract_term":{"duration":6},"rent":{"duration":6,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}},"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","replace_all":false}],"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["seller_id","offer_line_contract_terms"]},"AddFirstPartyServiceByPricingCategoryOpsRequestBody":{"type":"object","properties":{"offer_line_categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoriesByOfferLine"},"example":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","pricing_category":"iphone_17_pro"}]},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"offer_line_categories":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","pricing_category":"iphone_17_pro"}],"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["seller_id","offer_line_categories"]},"AddFirstPartyServiceOverrideForProductRequestBody":{"type":"object","properties":{"additional_values":{"$ref":"#/components/schemas/FirstPartyServiceAdditionalValues"},"disabled":{"type":"boolean","description":"If the service should be disabled for a given product","example":false},"monthly_price":{"$ref":"#/components/schemas/MoneyAmount"},"type":{"type":"string","description":"The kind of first party service available","example":"topi_replace","enum":["topi_repair","topi_replace","demo_first_party_service","topi_accessory","topi_data_deletion_certificate","topi_care_plus_synaxon","topi_care_plus_michaelag"]}},"example":{"additional_values":{"accessory_type":"experiment_charger","deductible_price":{"currency":"EUR","gross":119000,"net":100000},"images":{"url1x":"abc123","url2x":"abc123","url3x":"abc123"}},"disabled":false,"monthly_price":{"currency":"EUR","gross":119000,"net":100000},"type":"topi_replace"},"required":["type","disabled"]},"AddInvoicesRequestBody":{"type":"object","properties":{"invoices":{"type":"array","items":{"$ref":"#/components/schemas/InvoicePayload"},"description":"Invoices to add or update","example":[{"amount":{"currency":"EUR","gross":119000,"net":100000},"confirm_overwrite":false,"contract_type":"rent","duration":6,"encrypted_invoice_number":"abc123","file":"abc123","invoice_date":"abc123","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","transaction_type":"invoice","withdrawal_date":"1970-01-01T00:00:01Z"},{"amount":{"currency":"EUR","gross":119000,"net":100000},"confirm_overwrite":false,"contract_type":"rent","duration":6,"encrypted_invoice_number":"abc123","file":"abc123","invoice_date":"abc123","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","transaction_type":"invoice","withdrawal_date":"1970-01-01T00:00:01Z"}],"minItems":1},"send_email":{"type":"boolean","description":"Should adding invoices trigger email to the user","example":false}},"example":{"invoices":[{"amount":{"currency":"EUR","gross":119000,"net":100000},"confirm_overwrite":false,"contract_type":"rent","duration":6,"encrypted_invoice_number":"abc123","file":"abc123","invoice_date":"abc123","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","transaction_type":"invoice","withdrawal_date":"1970-01-01T00:00:01Z"},{"amount":{"currency":"EUR","gross":119000,"net":100000},"confirm_overwrite":false,"contract_type":"rent","duration":6,"encrypted_invoice_number":"abc123","file":"abc123","invoice_date":"abc123","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","transaction_type":"invoice","withdrawal_date":"1970-01-01T00:00:01Z"}],"send_email":false},"required":["invoices","send_email"]},"AddOfferOpsRequestBody":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/SalesAgent"},"customer":{"$ref":"#/components/schemas/CustomerInfoPayload"},"expires_at":{"type":"string","description":"Expiration datetime (UTC)","example":"1970-01-01T00:00:01Z","format":"date-time"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OfferLinePayload"},"description":"Product lines","example":[{"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"}],"pretty_id":"abc123","price":{"currency":"EUR","gross":119000,"net":100000},"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_references":[{"reference":"123ab-5343","source":"sap"}],"subtitle":"abc123","title":"abc123"}]},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"shipping_address":{"$ref":"#/components/schemas/Address"},"shipping_info":{"$ref":"#/components/schemas/ShippingInfo"},"supersedes_id":{"type":"string","description":"The id of the offer that is superseded by this one","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"customer":{"company":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"123456789","name":"abc123","tax_number":"abc123","type":"Partnership","vat_number":"DE123456789"},"customer_group":"abc123","email":"alice@example.com","full_name":"abc123"},"expires_at":"1970-01-01T00:00:01Z","lines":[{"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"}],"pretty_id":"abc123","price":{"currency":"EUR","gross":119000,"net":100000},"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_references":[{"reference":"123ab-5343","source":"sap"}],"subtitle":"abc123","title":"abc123"}],"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","shipping_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"shipping_info":{"is_in_store_pickup":false,"price":{"currency":"EUR","gross":119000,"net":100000},"seller_shipping_reference":"Sandbox Shipping Service"},"supersedes_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["seller_id","lines","agent","seller_offer_reference","expires_at"]},"AddOfferPayload":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/SalesAgent"},"customer":{"$ref":"#/components/schemas/CustomerInfoPayload"},"expires_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OfferLinePayload"},"description":"Product lines","example":[{"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"}],"pretty_id":"abc123","price":{"currency":"EUR","gross":119000,"net":100000},"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_references":[{"reference":"123ab-5343","source":"sap"}],"subtitle":"abc123","title":"abc123"}]},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"shipping_address":{"$ref":"#/components/schemas/Address"},"shipping_info":{"$ref":"#/components/schemas/ShippingInfo"},"supersedes_id":{"type":"string","description":"The id of the offer that is superseded by this one","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"customer":{"company":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"123456789","name":"abc123","tax_number":"abc123","type":"Partnership","vat_number":"DE123456789"},"customer_group":"abc123","email":"alice@example.com","full_name":"abc123"},"expires_at":"1970-01-01T00:00:01Z","lines":[{"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"}],"pretty_id":"abc123","price":{"currency":"EUR","gross":119000,"net":100000},"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_references":[{"reference":"123ab-5343","source":"sap"}],"subtitle":"abc123","title":"abc123"}],"seller_offer_reference":"abc123","shipping_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"shipping_info":{"is_in_store_pickup":false,"price":{"currency":"EUR","gross":119000,"net":100000},"seller_shipping_reference":"Sandbox Shipping Service"},"supersedes_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["lines","agent","seller_offer_reference","expires_at"]},"AddOrUpdateOpsRequestBody":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/AllowlistItem"},"description":"Rows to add or update in the allowlist","example":[{"comment":"abc123","email":"abc123","transaction_limit":1}]}},"example":{"rows":[{"comment":"abc123","email":"abc123","transaction_limit":1}]},"required":["rows"]},"AddProduct":{"type":"object","properties":{"base_rental_price":{"$ref":"#/components/schemas/MoneyAmount"},"description":{"type":"string","description":"Description of product","example":"aaa","maxLength":2000},"extra_details":{"type":"array","items":{"$ref":"#/components/schemas/ExtraProductDetails"},"description":"Extra details about the product such as CPU, Memory, storage...","example":[{"property":"memory","value":"16GB DDR5"}]},"image":{"$ref":"#/components/schemas/ProductImage"},"is_active":{"type":"boolean","description":"If product is still active","example":false},"list_price":{"$ref":"#/components/schemas/MoneyAmount"},"manufacturer":{"type":"string","description":"The product manufacturer","example":"abc123"},"origin_seller":{"type":"string","description":"the seller origin for central catalog","example":"abc123"},"origin_seller_references":{"type":"array","items":{"$ref":"#/components/schemas/SellerProductReference"},"description":"the origin seller references for the central catalog","example":[{"reference":"123ab-5343","source":"sap"}]},"pretty_id":{"type":"string","description":"The visual overriding id of the product","example":"abc123"},"pricing_category":{"type":"string","description":"The pricing category that should be assigned","example":"iphone_17_pro","enum":["iphone_17","iphone_17_pro","iphone_17_pro_max","iphone_air","iphone_17_e","iphone_16_pro_max","iphone_16_pro","iphone_16_plus","iphone_16","iphone_15_pro_max","iphone_15_pro","iphone_15_plus","iphone_15","iphone_14_pro_max","iphone_14_pro","iphone_14_plus","iphone_14","iphone_13_pro_max","iphone_13_pro","iphone_13","iphone_12","iphone_11","iphone_se_22","iphone_se_20","macbook_pro_13_14","macbook_pro_13_14_m3","macbook_pro_13_14_m4","macbook_pro_13_14_m5","macbook_pro_15_16","macbook_pro_15_16_m3","macbook_pro_15_16_m4","macbook_pro_15_16_m5","macbook_air","macbook_air_13_m5","macbook_air_15_m5","macbook_neo","mac_desktop","mac_desktop_m4","mac_studio","mac_pro_m2","apple_display","studio_display_2026","studio_display_2022","studio_display_xdr","ipad_pro","ipad_pro_m5","ipad_pro_m4","ipad_pro_12_9_inch_7_gen","ipad_pro_12_9_inch_6_gen","ipad_pro_12_9_inch_5_gen","ipad_pro_11_inch_4_gen","ipad_air","ipad_air_m4","ipad_air_m3","ipad_air_6_gen","ipad_air_5_gen","ipad_air_4_gen","ipad_regular","ipad_regular_11_gen","ipad_regular_10_gen","ipad_regular_9_gen","ipad_mini","ipad_mini_6_gen","smartwatch_apple","smartwatch_apple_ultra","smartwatch_other","laptop_other_top","laptop_other_low","desktop_other_top","desktop_other_low","phone_other_top","phone_other_low","tablet_other_top","tablet_other_low","screen","accessory_other","accessory_airpods","accessory_pencil","accessory_homepod","accessory_visionpro","services_insurance","software","services_management","printer","iphone_16_e","server","network_security","mac_pro","mac_studio_m3","mac_studio_m4","accessory_smartfolio","accessory_appletv","accessory_gpu",""]},"pricing_category_confidence":{"type":"integer","description":"Optional confidence of the category classification","example":1,"format":"int64","minimum":0,"maximum":100},"product_standard_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/ProductStandardIdentifier"},"description":"Standard identifiers for this product","example":[{"id":"123ab-4567","identifier_type":"EAN"}]},"publicized_price":{"$ref":"#/components/schemas/MoneyAmount"},"seller_categories":{"type":"array","items":{"$ref":"#/components/schemas/ProductSellerCategory"},"description":"Categories from the seller","example":[{"id":"abc123","name":"abc123","parent_category":"abc123"}]},"seller_product_references":{"type":"array","items":{"$ref":"#/components/schemas/SellerProductReference"},"description":"Partner's own reference for this product","example":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"minItems":1},"seller_product_type":{"type":"string","example":"software","enum":["hardware","software","service","hardware_built_to_order"]},"shop_product_description_url":{"type":"string","example":"https://example.com/foo","format":"uri"},"subtitle":{"type":"string","description":"Subtitle of product","example":"abc123"},"title":{"type":"string","description":"Name for product","example":"abc123"}},"example":{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"image":{"url":"https://example.com/foo"},"is_active":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"},"required":["title","seller_product_references","publicized_price","is_active"]},"AddSellerPayload":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"can_provide_serial_numbers":{"type":"boolean","description":"If the seller can provide serial number for assets","example":false},"can_use_parent_catalog":{"type":"boolean","description":"Allow the seller to use the parent catalog?","example":false},"capability_add_custom_products":{"type":"boolean","description":"If the seller can add custom products","example":false},"capability_anonymized_pricing":{"type":"boolean","description":"If the seller wishes to anonymize catalog prices","example":false},"capability_anonymous_ecom_offer_creation":{"type":"boolean","description":"Ability to skip required shipping address for ecom offers.","example":false},"capability_bundles":{"type":"boolean","description":"If the seller has bundles enabled","example":false},"capability_central_catalog":{"type":"boolean","description":"enable or disable central catalog","example":false},"capability_chatbot_id":{"type":"string","description":"Chatbot id for the seller. This enables a chatbase chatbot for the seller","example":"abc123"},"capability_dual_pricing":{"type":"boolean","description":"If the seller can set dual pricing","example":false},"capability_email_end_customer_on_offer_created":{"type":"boolean","description":"Ability to email the end customers when offers are created","example":false},"capability_hide_buy_now":{"type":"boolean","description":"If the seller should hide purchase only as option.","example":false},"capability_international_shipment":{"type":"boolean","description":"If the seller has international shipment enabled","example":false},"capability_show_ecom_orders":{"type":"boolean","description":"Show ecommerce orders to all telesales","example":false},"cc_ecommerce_is_active":{"type":"boolean","description":"If we should send notifications to the seller's CC email addresses when the channel is ecommerce","example":false},"cc_offer_accepted":{"type":"string","description":"The email addresses to send notifications when an offer is accepted separated by comma","example":"abc123"},"cc_offer_created":{"type":"string","description":"The email addresses to send notifications when an offer is created separated by comma","example":"abc123"},"cc_offer_declined":{"type":"string","description":"The email addresses to send notifications when an offer is declined separated by comma","example":"abc123"},"cc_telesales_is_active":{"type":"boolean","description":"If we should send notifications to the seller's CC email addresses when the channel is telesales","example":false},"currency":{"type":"string","description":"Currency code, see ISO 4127 (https://www.iso.org/iso-4217-currency-codes.html) (supported: EUR, GBP, USD)","example":"EUR"},"email":{"type":"string","description":"The email for contacting the seller customer service","example":"email@domain.com","minLength":1,"maxLength":255},"erp_integrated":{"type":"boolean","description":"If the seller is ERP integrated","example":false},"external_contractual_entity":{"type":"string","description":"The external contractual entity name (e.g. peac)","example":"abc123"},"external_id":{"type":"string","description":"The external ID assigned by the contractual entity partner","example":"abc123"},"kickback_ratio":{"type":"number","description":"The kickback ratio for the seller","example":1,"format":"double"},"logo_url":{"type":"string","description":"The url of the seller logo","example":"abc123"},"name":{"type":"string","description":"The name of the seller","example":"aa","minLength":1,"maxLength":255},"parent_seller_id":{"type":"string","description":"The ID of the parent seller, we use this for multipliers","example":"abc123"},"pdf_reader_assistant_id":{"type":"string","description":"The assistant ID to use for PDF reader, use null to disable PDF reader","example":"abc123"},"pretty_name":{"type":"string","description":"The pretty, user-facing name of the seller","example":"aa","minLength":1,"maxLength":255},"product_reference_source":{"type":"string","description":"The database/software/system that the Seller use to manage their products, ex. SKU/SAP","example":"aa","minLength":1,"maxLength":255},"risk_status":{"type":"string","description":"The risk assessment status for the external contractual entity","example":"approved","enum":["pending","approved","declined"]},"shipping_method_name":{"type":"string","description":"the name of the shipping method","example":"abc123"},"shipping_method_seller_reference":{"type":"string","description":"the reference of the shipping method in the seller","example":"abc123"},"status_changed_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"can_provide_serial_numbers":false,"can_use_parent_catalog":false,"capability_add_custom_products":false,"capability_anonymized_pricing":false,"capability_anonymous_ecom_offer_creation":false,"capability_bundles":false,"capability_central_catalog":false,"capability_chatbot_id":"abc123","capability_dual_pricing":false,"capability_email_end_customer_on_offer_created":false,"capability_hide_buy_now":false,"capability_international_shipment":false,"capability_show_ecom_orders":false,"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false,"currency":"EUR","email":"email@domain.com","erp_integrated":false,"external_contractual_entity":"abc123","external_id":"abc123","kickback_ratio":1,"logo_url":"abc123","name":"aa","parent_seller_id":"abc123","pdf_reader_assistant_id":"abc123","pretty_name":"aa","product_reference_source":"aa","risk_status":"approved","shipping_method_name":"abc123","shipping_method_seller_reference":"abc123","status_changed_at":"1970-01-01T00:00:01Z"},"required":["name","pretty_name","email","product_reference_source","address","shipping_method_name","shipping_method_seller_reference","capability_central_catalog","capability_dual_pricing","erp_integrated","can_provide_serial_numbers","capability_hide_buy_now","capability_anonymized_pricing","capability_bundles","capability_show_ecom_orders","capability_email_end_customer_on_offer_created","capability_anonymous_ecom_offer_creation","capability_international_shipment","currency"]},"AddUserPayload":{"type":"object","properties":{"email":{"type":"string","description":"The email of the user","example":"abc123"},"email_lang":{"type":"string","example":"en","enum":["de","en","nl"]},"first_name":{"type":"string","description":"The first name of the user","example":"abc123"},"last_name":{"type":"string","description":"The last name of the user","example":"abc123"}},"description":"Payload for adding an user as ops","example":{"email":"abc123","email_lang":"en","first_name":"abc123","last_name":"abc123"},"required":["email","first_name","last_name","email_lang"]},"AddWebhookPayload":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"string","example":"order","enum":["offer","order"]},"description":"The types of messages to retrieve. If you don't set anything, the message will be send to all urls","example":["order"]},"url":{"type":"string","description":"The url to register where we will notify the changes","example":"abc123"}},"example":{"channels":["order"],"url":"abc123"},"required":["url"]},"Address":{"type":"object","properties":{"city":{"type":"string","description":"City","example":"abc123"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2","example":"DE"},"line1":{"type":"string","description":"First line (street, number, etc.)","example":"abc123"},"line2":{"type":"string","description":"Second line (flat number, etc.)","example":"aaa","maxLength":40},"postal_code":{"type":"string","description":"Postal code","example":"abc123"},"region":{"type":"string","description":"Region, county, province, etc.","example":"abc123"}},"example":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"required":["line1","postal_code","city","country_code"]},"AllOffersOpsPayload":{"type":"object","properties":{"contract_entity":{"type":"array","items":{"type":"string","example":"abc123"},"description":"Contract entity","example":["abc123"]},"end_customer_id":{"type":"string","description":"Id of the end customer","example":"abc123"},"pending_serial_numbers":{"type":"boolean","description":"Accepted offer that serial number has been pending","example":false},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"status":{"type":"array","items":{"type":"string","example":"voided","enum":["created","voided","accepted","expired","rejected","pending_review","declined","id_verification_expired"]},"description":"Offer status","example":["voided"]}},"example":{"contract_entity":["abc123"],"end_customer_id":"abc123","pending_serial_numbers":false,"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","status":["voided"]}},"AllowlistItem":{"type":"object","properties":{"comment":{"type":"string","description":"Comment about the entry","example":"abc123"},"email":{"type":"string","description":"Email in the allowlist","example":"abc123"},"transaction_limit":{"type":"integer","description":"Transaction limit set for customer","example":1,"format":"int64"}},"example":{"comment":"abc123","email":"abc123","transaction_limit":1},"required":["email","transaction_limit"]},"AnonymizedOffer":{"type":"object","properties":{"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"customer_has_vat_number":{"type":"boolean","example":false},"email":{"type":"string","description":"User's email that was added on offer creation","example":"alice@example.com","format":"email"},"exit_redirect":{"type":"string","description":"URL used to redirect if there is an error","example":"abc123"},"expires_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"has_single_term_duration":{"type":"boolean","description":"Whether all rental line items must share a single term duration (derived from the contractual entity)","example":false},"id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OfferLine"},"description":"Product lines","example":[{"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"}]},"payment_method_required":{"type":"boolean","description":"Whether the checkout must collect a payment method (derived from the offer's contractual entity server-side)","example":false},"pricing_overview":{"$ref":"#/components/schemas/PricingOverview"},"redirect_to_superseding_offer_url":{"type":"string","description":"link to the top-most superseding offer","example":"abc123"},"sales_channel":{"type":"string","example":"ecommerce","enum":["telesales","ecommerce"]},"seller_info":{"$ref":"#/components/schemas/SellerInfo"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"shipping":{"$ref":"#/components/schemas/ShippingInfo"},"status":{"type":"string","example":"voided","enum":["created","voided","accepted","expired","rejected","pending_review","declined"]}},"example":{"created_at":"1970-01-01T00:00:01Z","customer_has_vat_number":false,"email":"alice@example.com","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"}],"payment_method_required":false,"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"},"status":"voided"},"required":["expires_at","created_at","id","status","lines","seller_offer_reference","seller_info","sales_channel","customer_has_vat_number","pricing_overview","payment_method_required","has_single_term_duration"]},"AnonymizedUser":{"type":"object","properties":{"email_hash":{"type":"string","example":"abc123"},"email_verified":{"type":"boolean","example":false},"end_customer_id":{"type":"string","example":"abc123"},"has_end_customer_enroled":{"type":"boolean","example":false},"has_user_enroled":{"type":"boolean","example":false},"has_user_signed_up":{"type":"boolean","example":false},"terms_accepted":{"type":"boolean","example":false}},"example":{"email_hash":"abc123","email_verified":false,"end_customer_id":"abc123","has_end_customer_enroled":false,"has_user_enroled":false,"has_user_signed_up":false,"terms_accepted":false},"required":["end_customer_id","email_hash","email_verified","terms_accepted","has_user_signed_up","has_user_enroled","has_end_customer_enroled"]},"Asset":{"type":"object","properties":{"belongs_to_asset_id":{"type":"string","description":"reference to parent asset ID, if this asset is a child","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"id":{"type":"string","description":"asset ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"offer_line_id":{"type":"string","description":"reference to the originating offer_line","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"product_id":{"type":"string","description":"product id inside the topi catalog","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"requires_serial_number":{"type":"boolean","description":"if the asset requires a serial number","example":false},"seller_product_references":{"type":"array","items":{"$ref":"#/components/schemas/SellerProductReference"},"description":"All seller's own references for this asset","example":[{"reference":"123ab-5343","source":"sap"}]},"serial_number":{"type":"string","description":"This is an id that identifies this asset as unique","example":"BA-3456786-334-9"},"status":{"type":"string","example":"shipped","enum":["created","shipped","return_completed","purchased","return_in_progress","upgrade_in_progress","purchase_in_progress","upgrade_in_progress_in_term","return_in_progress_in_term","ops_canceled","ending_soon","overdue"]},"title":{"type":"string","description":"The name of the asset","example":"Pro Laptop 64GB"},"tracking_url":{"type":"string","description":"the tracking url of this specific asset","example":"abc123"}},"description":"An item included in an order","example":{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"},"required":["id","product_id","title","seller_product_references","status"]},"AssetDetail":{"type":"object","properties":{"id":{"type":"string","description":"asset ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"offer_id":{"type":"string","description":"reference to the originating offer","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"serial_number":{"type":"string","description":"This is an id that identifies this asset as unique","example":"BA-3456786-334-9"},"status":{"type":"string","example":"shipped","enum":["created","shipped","return_completed","purchased","return_in_progress","upgrade_in_progress","purchase_in_progress","upgrade_in_progress_in_term","return_in_progress_in_term","ops_canceled","ending_soon","overdue"]},"subtitle":{"type":"string","description":"The asset title from txlog","example":"abc123"},"title":{"type":"string","description":"The pretty name of the asset","example":"Pro Laptop 64GB"},"txlog_status":{"type":"string","description":"The status from txlog","example":"abc123"}},"description":"An asset detail with info from the txlog and end customer","example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","serial_number":"BA-3456786-334-9","status":"shipped","subtitle":"abc123","title":"Pro Laptop 64GB","txlog_status":"abc123"},"required":["id","title","status"]},"AssetIDs":{"type":"object","properties":{"current_id":{"type":"string","description":"Asset ID from the database","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"new_id":{"type":"string","description":"Asset ID from the Txlog","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"current_id":"739b63c2-9e58-4964-b38d-4ebb424de242","new_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["current_id","new_id"]},"AssignBrandingToSellerRequestBody":{"type":"object","properties":{"branding_id":{"type":"string","description":"ID of the branding config to assign, null to remove the branding config","example":"abc123"},"seller_id":{"type":"string","description":"ID of the seller to assign the branding config to","example":"abc123"}},"example":{"branding_id":"abc123","seller_id":"abc123"},"required":["seller_id","branding_id"]},"BaseOfferLine":{"type":"object","properties":{"available_contract_terms":{"$ref":"#/components/schemas/ContractTerms"},"available_first_party_services":{"type":"array","items":{"$ref":"#/components/schemas/FirstPartyService"},"description":"Available first party services for the product","example":[{"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":{"$ref":"#/components/schemas/MoneyAmountWithOptionalGross"},"contract_terms_list":{"type":"array","items":{"$ref":"#/components/schemas/ContractTermItem"},"description":"Available terms for the product","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}]},"pretty_id":{"type":"string","description":"The pretty ID of the product","example":"abc123"},"price":{"$ref":"#/components/schemas/MoneyAmount"},"product_id":{"type":"string","description":"Product ID inside Topi catalog","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"quantity":{"type":"integer","description":"Amount of products","example":1,"format":"int64"},"requires_serial_number":{"type":"boolean","description":"Does the offerline require a serial number","example":false},"selected_contract_terms_id":{"type":"string","description":"Selected term id","example":"abc123"},"selected_first_party_service_ids":{"type":"array","items":{"type":"string","example":"abc123"},"description":"Selected first party services ids","example":["abc123"]},"seller_product_references":{"type":"array","items":{"$ref":"#/components/schemas/SellerProductReference"},"description":"Partner's own reference for this product","example":[{"reference":"123ab-5343","source":"sap"}]},"subtitle":{"type":"string","description":"The product subtitle","example":"abc123"},"title":{"type":"string","description":"The product name","example":"abc123"}},"example":{"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"}],"pretty_id":"abc123","price":{"currency":"EUR","gross":119000,"net":100000},"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_references":[{"reference":"123ab-5343","source":"sap"}],"subtitle":"abc123","title":"abc123"},"required":["quantity","price","seller_product_references","title"]},"BaseOfferLineResult":{"type":"object","properties":{"applied_discount_id":{"type":"string","description":"The ID of any discount applied to the offer line","example":"abc123"},"available_contract_terms":{"$ref":"#/components/schemas/ContractTerms"},"available_first_party_services":{"type":"array","items":{"$ref":"#/components/schemas/FirstPartyService"},"description":"Available first party services for the product","example":[{"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":{"$ref":"#/components/schemas/MoneyAmountWithOptionalGross"},"contract_terms_list":{"type":"array","items":{"$ref":"#/components/schemas/ContractTermItem"},"description":"Available terms for the product","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}]},"id":{"type":"string","description":"The offer line Id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"pretty_id":{"type":"string","description":"The pretty ID of the product","example":"abc123"},"price":{"$ref":"#/components/schemas/MoneyAmount"},"pricing_category":{"type":"string","description":"The topi-assigned pricing category for the product","example":"legacy_phone_24","enum":["legacy_laptop_36","legacy_phone_24","iphone_17","iphone_17_pro","iphone_17_pro_max","iphone_air","iphone_17_e","iphone_16_pro_max","iphone_16_pro","iphone_16_plus","iphone_16","iphone_15_pro_max","iphone_15_pro","iphone_15_plus","iphone_15","iphone_14_pro_max","iphone_14_pro","iphone_14_plus","iphone_14","iphone_13_pro_max","iphone_13_pro","iphone_13","iphone_13_mini","iphone_12_pro_max","iphone_12_pro","iphone_12","iphone_12_mini","iphone_11","iphone_se_22","iphone_se_20","macbook_pro_13_14","macbook_pro_13_14_m3","macbook_pro_13_14_m4","macbook_pro_13_14_m5","macbook_pro_15_16","macbook_pro_15_16_m3","macbook_pro_15_16_m4","macbook_pro_15_16_m5","macbook_air","macbook_air_13_m5","macbook_air_15_m5","macbook_neo","mac_desktop","mac_desktop_m4","mac_studio","mac_studio_m3m4","mac_pro_m2","apple_display","studio_display_2026","studio_display_2022","studio_display_xdr","ipad_pro","ipad_pro_m5","ipad_pro_m4","ipad_pro_12_9_inch_7_gen","ipad_pro_12_9_inch_6_gen","ipad_pro_12_9_inch_5_gen","ipad_pro_12_9_inch_4_gen","ipad_pro_12_9_inch_3_gen","ipad_pro_12_9_inch_2_gen","ipad_pro_12_9_inch_1_gen","ipad_pro_11_inch_4_gen","ipad_pro_11_inch_3_gen","ipad_pro_11_inch_2_gen","ipad_pro_11_inch_1_gen","ipad_pro_10_5_inch","ipad_air","ipad_air_m4","ipad_air_m3","ipad_air_6_gen","ipad_air_5_gen","ipad_air_4_gen","ipad_air_3_gen","ipad_air_2_gen","ipad_air_1_gen","ipad_regular","ipad_regular_11_gen","ipad_regular_10_gen","ipad_regular_9_gen","ipad_regular_8_gen","ipad_regular_7_gen","ipad_regular_6_gen","ipad_regular_5_gen","ipad_mini","ipad_mini_6_gen","ipad_mini_5_gen","ipad_mini_4_gen","ipad_mini_3_gen","ipad_mini_2_gen","ipad_mini_1_gen","smartwatch_apple","smartwatch_apple_ultra","smartwatch_other","laptop_other_top","laptop_other_low","desktop_other_top","desktop_other_low","phone_other_top","phone_other_low","tablet_other_top","tablet_other_low","screen","accessory_other","accessory_airpods","accessory_pencil","accessory_homepod","accessory_visionpro","services_insurance","software","services_management","other","bundle","second_hand","sandbox_supported_product","printer","iphone_16_e","server","network_security","mac_pro","mac_studio_m3","mac_studio_m4","accessory_smartfolio","accessory_appletv","accessory_gpu",""]},"product_id":{"type":"string","description":"Product ID inside Topi catalog","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"quantity":{"type":"integer","description":"Amount of products","example":1,"format":"int64"},"requires_serial_number":{"type":"boolean","description":"Does the offerline require a serial number","example":false},"selected_contract_terms_id":{"type":"string","description":"Selected term id","example":"abc123"},"selected_first_party_service_ids":{"type":"array","items":{"type":"string","example":"abc123"},"description":"Selected first party services ids","example":["abc123"]},"seller_product_provided_by":{"type":"string","description":"Who the ultimate provider for the product is","example":"abc123"},"seller_product_references":{"type":"array","items":{"$ref":"#/components/schemas/SellerProductReference"},"description":"Partner's own reference for this product","example":[{"reference":"123ab-5343","source":"sap"}]},"seller_product_type":{"type":"string","example":"software","enum":["hardware","software","service","hardware_built_to_order"]},"subtitle":{"type":"string","description":"The product subtitle","example":"abc123"},"title":{"type":"string","description":"The product name","example":"abc123"}},"description":"A product line contained in an offer","example":{"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"},"required":["id","quantity","price","seller_product_references","title"]},"Branding":{"type":"object","properties":{"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"email_logo_url":{"type":"string","description":"Url for the logo to display in emails, if any","example":"abc123"},"enable_transactional_emails":{"type":"boolean","description":"Whether or not to enable transactional emails","example":false},"id":{"type":"string","description":"ID of branding config","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"info_hub_url":{"type":"string","description":"Url for the info hub, if any","example":"abc123"},"logo_url":{"type":"string","description":"Url for the logo to display, if any","example":"abc123"},"name":{"type":"string","description":"Name of the branding config","example":"abc123"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"created_at":"1970-01-01T00:00:01Z","email_logo_url":"abc123","enable_transactional_emails":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","info_hub_url":"abc123","logo_url":"abc123","name":"abc123","updated_at":"1970-01-01T00:00:01Z"},"required":["id","name","enable_transactional_emails","created_at","updated_at"]},"BrandingForSeller":{"type":"object","properties":{"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"email_logo_url":{"type":"string","description":"Url for the logo to display in emails, if any","example":"abc123"},"enable_transactional_emails":{"type":"boolean","description":"Whether or not to enable transactional emails","example":false},"id":{"type":"string","description":"ID of branding config","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"info_hub_url":{"type":"string","description":"Url for the info hub, if any","example":"abc123"},"logo_url":{"type":"string","description":"Url for the logo to display, if any","example":"abc123"},"name":{"type":"string","description":"Name of the branding config","example":"abc123"},"seller_id":{"type":"string","description":"ID of the seller for the branding config","example":"abc123"},"seller_name":{"type":"string","description":"Name of the seller","example":"abc123"},"seller_pretty_name":{"type":"string","description":"Pretty name of the seller","example":"abc123"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"created_at":"1970-01-01T00:00:01Z","email_logo_url":"abc123","enable_transactional_emails":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","info_hub_url":"abc123","logo_url":"abc123","name":"abc123","seller_id":"abc123","seller_name":"abc123","seller_pretty_name":"abc123","updated_at":"1970-01-01T00:00:01Z"},"required":["seller_id","seller_pretty_name","seller_name","id","name","enable_transactional_emails","created_at","updated_at"]},"BrandingInfo":{"type":"object","properties":{"logo_url":{"type":"string","description":"Url for the logo to display, if any","example":"abc123"}},"example":{"logo_url":"abc123"}},"BuyoutRequest":{"type":"object","properties":{"asset_id":{"type":"string","description":"ID of asset","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"asset_status":{"type":"string","example":"shipped","enum":["created","shipped","return_completed","purchased","return_in_progress","upgrade_in_progress","purchase_in_progress","upgrade_in_progress_in_term","return_in_progress_in_term","ops_canceled","ending_soon","overdue"]},"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"price_net":{"$ref":"#/components/schemas/MoneyValue"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"user_id":{"type":"string","description":"ID of user","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","asset_status":"shipped","created_at":"1970-01-01T00:00:01Z","price_net":{"amount":34000,"currency":"EUR"},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["asset_id","user_id","asset_status","created_at","updated_at"]},"CalculateTerminationFeesOpsRequestBody":{"type":"object","properties":{"actual_tenure_override":{"type":"integer","description":"Actual tenure override","example":1,"format":"int64"},"fetch_realtime_trade_in_price":{"type":"boolean","description":"Whether to fetch the realtime trade in price from partner","example":false},"trade_in_price_override":{"type":"integer","description":"Trade-in price override (in cents)","example":1,"format":"int64"}},"example":{"actual_tenure_override":1,"fetch_realtime_trade_in_price":false,"trade_in_price_override":1},"required":["fetch_realtime_trade_in_price"]},"CategoriesByOfferLine":{"type":"object","properties":{"offer_line_id":{"type":"string","description":"The id of the offer line related","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"pricing_category":{"type":"string","description":"the seller category category type","example":"iphone_17_pro","enum":["iphone_17","iphone_17_pro","iphone_17_pro_max","iphone_air","iphone_17_e","iphone_16_pro_max","iphone_16_pro","iphone_16_plus","iphone_16","iphone_15_pro_max","iphone_15_pro","iphone_15_plus","iphone_15","iphone_14_pro_max","iphone_14_pro","iphone_14_plus","iphone_14","iphone_13_pro_max","iphone_13_pro","iphone_13","iphone_12","iphone_11","iphone_se_22","iphone_se_20","macbook_pro_13_14","macbook_pro_13_14_m3","macbook_pro_13_14_m4","macbook_pro_13_14_m5","macbook_pro_15_16","macbook_pro_15_16_m3","macbook_pro_15_16_m4","macbook_pro_15_16_m5","macbook_air","macbook_air_13_m5","macbook_air_15_m5","macbook_neo","mac_desktop","mac_desktop_m4","mac_studio","mac_pro_m2","apple_display","studio_display_2026","studio_display_2022","studio_display_xdr","ipad_pro","ipad_pro_m5","ipad_pro_m4","ipad_pro_12_9_inch_7_gen","ipad_pro_12_9_inch_6_gen","ipad_pro_12_9_inch_5_gen","ipad_pro_11_inch_4_gen","ipad_air","ipad_air_m4","ipad_air_m3","ipad_air_6_gen","ipad_air_5_gen","ipad_air_4_gen","ipad_regular","ipad_regular_11_gen","ipad_regular_10_gen","ipad_regular_9_gen","ipad_mini","ipad_mini_6_gen","smartwatch_apple","smartwatch_apple_ultra","smartwatch_other","laptop_other_top","laptop_other_low","desktop_other_top","desktop_other_low","phone_other_top","phone_other_low","tablet_other_top","tablet_other_low","screen","accessory_other","accessory_airpods","accessory_pencil","accessory_homepod","accessory_visionpro","services_insurance","software","services_management","printer","iphone_16_e","server","network_security","mac_pro","mac_studio_m3","mac_studio_m4","accessory_smartfolio","accessory_appletv","accessory_gpu",""]}},"example":{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","pricing_category":"iphone_17_pro"},"required":["pricing_category","offer_line_id"]},"CategorisationIdentifiers":{"type":"object","properties":{"category":{"type":"string","description":"the category of the product","example":"macbook"},"device":{"type":"string","description":"the device of the product","example":"macbook_pro_13"},"manufacturer":{"type":"string","description":"The manufacturer of the product","example":"apple"},"price":{"$ref":"#/components/schemas/MoneyAmountWithOptionalGross"}},"example":{"category":"macbook","device":"macbook_pro_13","manufacturer":"apple","price":{"currency":"EUR","gross":119000,"net":100000}},"required":["manufacturer","category","price"]},"CategorizationResult":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"abc123"},"description":"a list of error strings","example":["abc123"]},"total_categorized":{"type":"integer","description":"The total number of categorized products","example":1,"format":"int64"},"total_errors":{"type":"integer","description":"The total number of errors that occurred","example":1,"format":"int64"},"total_products":{"type":"integer","description":"The total number of products being processed","example":1,"format":"int64"}},"example":{"errors":["abc123"],"total_categorized":1,"total_errors":1,"total_products":1},"required":["total_products","total_categorized","total_errors","errors"]},"CategorizeProductsResponseBody":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/CategorizationResult"}},"example":{"result":{"errors":["abc123"],"total_categorized":1,"total_errors":1,"total_products":1}}},"CheckEmailTradeInProcessOpsPayload":{"type":"object","properties":{"asset_id":{"type":"string","description":"The asset ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"user_email":{"type":"string","description":"E-mail of the user that requested the trade-in process","example":"alice@example.com","format":"email"}},"example":{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","user_email":"alice@example.com"},"required":["user_email","asset_id"]},"CommonPortalAgent":{"type":"object","properties":{"email":{"type":"string","description":"E-mail","example":"alice@example.com","format":"email"},"external_agent_id":{"type":"string","description":"Id number used to identify the sales agent in the seller's internal system","example":"abc123"},"name":{"type":"string","description":"Name of the agent","example":"abc123"},"phone":{"type":"string","description":"Phone number","example":"abc123"},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_store_id":{"type":"string","description":"Id number used to identify the store a PoS agent is operating from","example":"abc123"}},"description":"A sales agent that can login into seller portal","example":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123"},"required":["name","phone","email"]},"CompanyInfo":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"company_registration_number":{"type":"string","description":"Company Registration Number (e.g. KVK, KBO, EIN)","example":"123456789","maxLength":255},"name":{"type":"string","description":"Name of the company","example":"abc123"},"tax_number":{"type":"string","description":"Tax Identification Number","example":"abc123"},"type":{"type":"string","description":"Type of the company (required for US)","example":"Partnership","enum":["Sole proprietorship","Partnership","Corporation","Limited Liability Company (LLC)"]},"vat_number":{"type":"string","description":"VAT Registration Number","example":"DE123456789"}},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"123456789","name":"abc123","tax_number":"abc123","type":"Partnership","vat_number":"DE123456789"},"required":["name","billing_address"]},"ContactsPayload":{"type":"object","properties":{"properties":{"type":"object","example":{"company":"Biglytics","email":"bcooper@biglytics.net","firstname":"Bryan","lastname":"Cooper","phone":"(877) 929-0687","website":"biglytics.net"},"additionalProperties":{"type":"string","example":"abc123"}}},"example":{"properties":{"company":"Biglytics","email":"bcooper@biglytics.net","firstname":"Bryan","lastname":"Cooper","phone":"(877) 929-0687","website":"biglytics.net"}},"required":["properties"]},"ContractTerm":{"type":"object","properties":{"id":{"type":"string","description":"The internal Id for the contract term","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"description":"Basic info for contract terms","example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242"}},"ContractTermItem":{"type":"object","properties":{"id":{"type":"string","description":"The internal Id for the contract term","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"payload":{"$ref":"#/components/schemas/ContractTermItemPayload"},"type":{"type":"string","description":"Different contracts type","example":"rent","enum":["pay_now","rent"]}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"},"required":["id","type","payload"]},"ContractTermItemPayload":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/MoneyAmount"},"duration":{"type":"integer","description":"The duration in months","example":6,"enum":[0,6,12,24,30,36,48],"format":"int64"}},"example":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"required":["amount","duration"]},"ContractTerms":{"type":"object","properties":{"pay_now":{"$ref":"#/components/schemas/PayNowContractTerm"},"rent":{"$ref":"#/components/schemas/RentContractTermResult"}},"example":{"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}}}},"ContractTermsAndServicesSelectedByOfferLine":{"type":"object","properties":{"offer_line_id":{"type":"string","description":"The id of the offer line related","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"selected_contract_terms_id":{"type":"string","description":"Selected terms id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"selected_services":{"type":"array","items":{"type":"string","example":"abc123"},"description":"The id(s) of the selected services","example":["abc123"]}},"example":{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_contract_terms_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_services":["abc123"]},"required":["offer_line_id","selected_contract_terms_id"]},"ContractTermsAndServicesSelectionPayload":{"type":"object","properties":{"lines":{"type":"array","items":{"$ref":"#/components/schemas/ContractTermsAndServicesSelectedByOfferLine"},"example":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_contract_terms_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_services":["abc123"]}]}},"example":{"lines":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_contract_terms_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_services":["abc123"]}]},"required":["lines"]},"ContractTermsByOfferLine":{"type":"object","properties":{"contract_terms":{"$ref":"#/components/schemas/NewContractTerms"},"offer_line_id":{"type":"string","description":"The id of the offer line related","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"replace_all":{"type":"boolean","description":"Instead of upserting terms, fully replace all terms with the current payload","default":false,"example":false}},"example":{"contract_terms":{"contract_terms":[{"payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}],"default_contract_term":{"duration":6},"rent":{"duration":6,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}},"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","replace_all":false},"required":["offer_line_id","contract_terms"]},"ContractTermsPayload":{"type":"object","properties":{"offer_line_contract_terms":{"type":"array","items":{"$ref":"#/components/schemas/ContractTermsByOfferLine"},"example":[{"contract_terms":{"contract_terms":[{"payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}],"default_contract_term":{"duration":6},"rent":{"duration":6,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}},"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","replace_all":false}]}},"example":{"offer_line_contract_terms":[{"contract_terms":{"contract_terms":[{"payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}],"default_contract_term":{"duration":6},"rent":{"duration":6,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}},"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","replace_all":false}]},"required":["offer_line_contract_terms"]},"ContractTermsSelectedByOfferLine":{"type":"object","properties":{"offer_line_id":{"type":"string","description":"The id of the offer line related","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"selected_contract_terms_id":{"type":"string","description":"Selected terms id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_contract_terms_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["offer_line_id","selected_contract_terms_id"]},"ContractTermsSelectionPayload":{"type":"object","properties":{"offer_line_contract_terms":{"type":"array","items":{"$ref":"#/components/schemas/ContractTermsSelectedByOfferLine"},"example":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_contract_terms_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}},"example":{"offer_line_contract_terms":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_contract_terms_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]},"required":["offer_line_contract_terms"]},"CreateDiscount":{"type":"object","properties":{"allowed_usage_count":{"type":"integer","description":"how many times this discount code can be used","example":1,"format":"int64"},"code":{"type":"string","description":"discount code","example":"abc123"},"description":{"type":"string","description":"discount description (campaign, seller ...","example":"abc123"},"minimum_merchandise_value":{"$ref":"#/components/schemas/MoneyValue"},"rules":{"type":"object","description":"How this discount will be applied","example":{"abc123":"abc123"},"additionalProperties":true},"seller_id":{"type":"string","description":"seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"type":{"type":"string","example":"fixed_initial_rent_waiver","enum":["fixed_initial_rent_waiver"]},"valid_from":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"valid_until":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"allowed_usage_count":1,"code":"abc123","description":"abc123","minimum_merchandise_value":{"amount":34000,"currency":"EUR"},"rules":{"abc123":"abc123"},"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"fixed_initial_rent_waiver","valid_from":"1970-01-01T00:00:01Z","valid_until":"1970-01-01T00:00:01Z"},"required":["seller_id","allowed_usage_count","type","rules","valid_from","valid_until"]},"CreateOpenBankingLinkOpsPayload":{"type":"object","properties":{"end_customer_id":{"type":"string","description":"End customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["end_customer_id"]},"CreateOpenBankingLinkOpsResult":{"type":"object","properties":{"open_banking_link":{"type":"string","description":"The open banking link to share with the end customer","example":"abc123"}},"example":{"open_banking_link":"abc123"},"required":["open_banking_link"]},"CreateProductRequestBody":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/AddProduct"}},"example":{"product":{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"image":{"url":"https://example.com/foo"},"is_active":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}},"required":["product"]},"CreateReminderPolicy":{"type":"object","properties":{"description":{"type":"string","description":"Reminder Policy's description","example":"abc123"},"reminder_type":{"type":"string","description":"Reminder type","example":"abc123"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/NewPolicyStep"},"description":"Reminder Policy's steps","example":[{"interval_days":1,"is_recurring":false,"step_number":1}]}},"example":{"description":"abc123","reminder_type":"abc123","steps":[{"interval_days":1,"is_recurring":false,"step_number":1}]},"required":["reminder_type","steps"]},"CreateRequestBody":{"type":"object","properties":{"pricing_category":{"$ref":"#/components/schemas/NewPricingCategory"}},"example":{"pricing_category":{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"identifier":"abc123","services":[{"name":"abc123","service_prices":[{"kind":"abc123","price":1,"tenure":1}]}]}}},"CreateRequestBody2":{"type":"object","properties":{"mode":{"type":"string","description":"API mode for the client","example":"live","enum":["live","sandbox"]},"name":{"type":"string","description":"OAuth client name (optional, auto-generated if not provided)","example":"Production API Access"}},"example":{"mode":"live","name":"Production API Access"},"required":["mode"]},"CreateShipmentRequestBody":{"type":"object","properties":{"order_id":{"type":"string","description":"topi order ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_id":{"type":"string","description":"id of the seller owner of this order","example":"abc123"},"serial_numbers":{"type":"array","items":{"$ref":"#/components/schemas/SerialNumberByAsset"},"description":"The serial numbers to register","example":[{"asset_id":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"},"serial_number":"BA-3456786-334-9","tracking_url":"abc123"}]}},"example":{"order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"abc123","serial_numbers":[{"asset_id":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"},"serial_number":"BA-3456786-334-9","tracking_url":"abc123"}]},"required":["order_id","serial_numbers","seller_id"]},"CreateShippingMethodPayload":{"type":"object","properties":{"is_in_store_pickup":{"type":"boolean","description":"Is this shipping method in store pickup?","example":false},"name":{"type":"string","description":"Name for the shipping method","example":"United Parcel Service"},"seller_id":{"type":"string","description":"The ID of the seller to add the shipping method for","example":"gravis"},"seller_shipping_method_reference":{"type":"string","description":"Seller's own reference for this shipping method","example":"Sandbox Shipping Service"}},"example":{"is_in_store_pickup":false,"name":"United Parcel Service","seller_id":"gravis","seller_shipping_method_reference":"Sandbox Shipping Service"},"required":["seller_shipping_method_reference","seller_id"]},"CreditLimitItem":{"type":"object","properties":{"available_credit_limit":{"type":"integer","description":"Available credit limit set for customer","example":1,"format":"int64"},"available_credit_limit_currency":{"type":"string","description":"Available credit limit currency set for customer","example":"abc123"},"comments":{"type":"string","description":"comments about this credit limit setted by ops","example":"abc123"},"credit_limit":{"type":"integer","description":"End customer credit limit","example":1,"format":"int64"},"credit_limit_currency":{"type":"string","description":"End customer credit limit currency","example":"abc123"},"end_customer_id":{"type":"string","description":"End customer ID","example":"abc123"}},"example":{"available_credit_limit":1,"available_credit_limit_currency":"abc123","comments":"abc123","credit_limit":1,"credit_limit_currency":"abc123","end_customer_id":"abc123"},"required":["end_customer_id"]},"CursorPageMetadata":{"type":"object","properties":{"has_more":{"type":"boolean","description":"Whether there are more pages","default":false,"example":false}},"description":"Metadata about the returned page","example":{"has_more":false},"required":["has_more"]},"CursorPagePayload":{"type":"object","properties":{"ending_before":{"type":"string","description":"A cursor to use in pagination. It will be the ending point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"limit":{"type":"integer","description":"How many results to return per page.","default":0,"example":10,"format":"int64","minimum":0},"page":{"type":"integer","description":"Which page number to fetch (zero-indexed)","default":0,"example":0,"format":"int64"},"starting_after":{"type":"string","description":"A cursor to use in pagination. It will be the starting point of the list and will not be included in the results.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"ending_before":"739b63c2-9e58-4964-b38d-4ebb424de242","limit":10,"page":0,"starting_after":"739b63c2-9e58-4964-b38d-4ebb424de242"}},"CustomerAccessoryCreationResponse":{"type":"object","properties":{"customer_feedback":{"type":"string","description":"The free form feedback","example":"abc123"},"id":{"type":"string","example":"abc123"},"offer_id":{"type":"string","description":"The id of the offer which the feedback is related to","example":"abc123"},"offer_line_id":{"type":"string","description":"The offerline which the user is currently checking addons for","example":"abc123"}},"example":{"customer_feedback":"abc123","id":"abc123","offer_id":"abc123","offer_line_id":"abc123"},"required":["customer_feedback","offer_id","offer_line_id"]},"CustomerAccessoryFeedback":{"type":"object","properties":{"customer_feedback":{"type":"string","description":"The free form feedback","example":"abc123"},"offer_id":{"type":"string","description":"The id of the offer which the feedback is related to","example":"abc123"},"offer_line_id":{"type":"string","description":"The offerline which the user is currently checking addons for","example":"abc123"}},"example":{"customer_feedback":"abc123","offer_id":"abc123","offer_line_id":"abc123"},"required":["customer_feedback","offer_id","offer_line_id"]},"CustomerInfo":{"type":"object","properties":{"company":{"$ref":"#/components/schemas/CompanyInfo"},"email":{"type":"string","description":"E-mail that will be used for the account","example":"alice@example.com","format":"email"},"end_customer_id":{"type":"string","description":"topi End Customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"full_name":{"type":"string","description":"Full name of the customer","example":"abc123"},"id":{"type":"string","description":"topi ID for the customer","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"company":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"123456789","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"},"required":["company"]},"CustomerInfoPayload":{"type":"object","properties":{"company":{"$ref":"#/components/schemas/CompanyInfo"},"customer_group":{"type":"string","description":"Group the customer is in","example":"abc123"},"email":{"type":"string","description":"E-mail that will be used for the account","example":"alice@example.com","format":"email"},"full_name":{"type":"string","description":"Full name of the customer","example":"abc123"}},"example":{"company":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"123456789","name":"abc123","tax_number":"abc123","type":"Partnership","vat_number":"DE123456789"},"customer_group":"abc123","email":"alice@example.com","full_name":"abc123"},"required":["email","company"]},"CustomerUpdateFailed":{"type":"object","properties":{"offer_id":{"type":"string","example":"abc123"},"reason":{"type":"string","example":"abc123"}},"example":{"offer_id":"abc123","reason":"abc123"},"required":["offer_id","reason"]},"DeleteUserRequestBody":{"type":"object","properties":{"user_email":{"type":"string","example":"alice@example.com","format":"email"}},"example":{"user_email":"alice@example.com"},"required":["user_email"]},"Discount":{"type":"object","properties":{"allowed_usage_count":{"type":"integer","description":"how many times this discount code can be used","example":1,"format":"int64"},"code":{"type":"string","description":"discount code","example":"abc123"},"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"description":{"type":"string","description":"discount description (campaign, seller ...","example":"abc123"},"disabled_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"id":{"type":"string","description":"discount ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"minimum_merchandise_value":{"$ref":"#/components/schemas/MoneyValue"},"rules":{"type":"object","description":"How this discount will be applied","example":{"abc123":"abc123"},"additionalProperties":true},"seller_id":{"type":"string","description":"seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"type":{"type":"string","example":"fixed_initial_rent_waiver","enum":["fixed_initial_rent_waiver"]},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"usage_count":{"type":"integer","example":1,"format":"int64"},"valid_from":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"valid_until":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"allowed_usage_count":1,"code":"abc123","created_at":"1970-01-01T00:00:01Z","description":"abc123","disabled_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","minimum_merchandise_value":{"amount":34000,"currency":"EUR"},"rules":{"abc123":"abc123"},"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"fixed_initial_rent_waiver","updated_at":"1970-01-01T00:00:01Z","usage_count":1,"valid_from":"1970-01-01T00:00:01Z","valid_until":"1970-01-01T00:00:01Z"},"required":["id","seller_id","allowed_usage_count","type","rules","valid_from","valid_until","created_at","updated_at","usage_count"]},"EndCustomer":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"company_address":{"$ref":"#/components/schemas/Address"},"company_registration_number":{"type":"string","description":"end-customer Company Registration Number","example":"abc123"},"email_domain":{"type":"string","description":"end-customer email domain","example":"abc123"},"group":{"type":"string","description":"end-customer group","example":"abc123"},"id":{"type":"string","description":"end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"in_migration":{"type":"boolean","description":"is the end-customer currently being migrated","example":false},"is_new":{"type":"boolean","description":"end-customer is new","example":false},"language":{"type":"string","description":"end-customer language","example":"abc123"},"name":{"type":"string","description":"end-customer name","example":"abc123"},"not_vat_registered":{"type":"boolean","description":"end-customer declared it has no VAT number","example":false},"risk_status":{"type":"string","description":"end-customer risk status","example":"abc123"},"tax_number":{"type":"string","description":"end-customer tax number","example":"abc123"},"type":{"type":"string","description":"Type of the company (required for US)","example":"Partnership","enum":["Sole proprietorship","Partnership","Corporation","Limited Liability Company (LLC)"]},"vat_number":{"type":"string","description":"end-customer VAT number","example":"abc123"}},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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,"risk_status":"abc123","tax_number":"abc123","type":"Partnership","vat_number":"abc123"},"required":["id","name","billing_address","is_new","email_domain","in_migration","language"]},"EndCustomerCreate":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"company_registration_number":{"type":"string","description":"end-customer Company Registration Number","example":"abc123"},"currency":{"type":"string","description":"end-customer currency","example":"abc123"},"email_domain":{"type":"string","description":"end-customer email domain","example":"abc123"},"group":{"type":"string","description":"end-customer group","example":"abc123"},"name":{"type":"string","description":"end-customer name","example":"abc123"},"tax_number":{"type":"string","description":"end-customer tax number","example":"abc123"},"vat_number":{"type":"string","description":"end-customer VAT number","example":"abc123"}},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"abc123","currency":"abc123","email_domain":"abc123","group":"abc123","name":"abc123","tax_number":"abc123","vat_number":"abc123"},"required":["id","name","billing_address","email_domain","currency"]},"EndCustomerForOps":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"company_address":{"$ref":"#/components/schemas/Address"},"company_registration_number":{"type":"string","description":"end-customer Company Registration Number","example":"abc123"},"contractual_entity":{"type":"string","description":"PSP contractual entity","example":"abc123"},"currency":{"type":"string","description":"end customer currency","example":"abc123"},"email_domain":{"type":"string","description":"end-customer email domain","example":"abc123"},"end_users":{"type":"array","items":{"$ref":"#/components/schemas/EndUser"},"description":"end-users information","example":[{"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"}]},"group":{"type":"string","description":"end-customer group","example":"abc123"},"id":{"type":"string","description":"end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"in_migration":{"type":"boolean","description":"is the end-customer currently being migrated","example":false},"is_new":{"type":"boolean","description":"end-customer is new","example":false},"language":{"type":"string","description":"end-customer language","example":"abc123"},"name":{"type":"string","description":"end-customer name","example":"abc123"},"not_vat_registered":{"type":"boolean","description":"end-customer declared it has no VAT number","example":false},"psp_provider":{"type":"string","description":"stripe","example":"abc123"},"risk_status":{"type":"string","description":"end-customer risk status","example":"abc123"},"tax_number":{"type":"string","description":"end-customer tax number","example":"abc123"},"type":{"type":"string","description":"Type of the company (required for US)","example":"Partnership","enum":["Sole proprietorship","Partnership","Corporation","Limited Liability Company (LLC)"]},"vat_number":{"type":"string","description":"end-customer VAT number","example":"abc123"}},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"abc123","contractual_entity":"abc123","currency":"abc123","email_domain":"abc123","end_users":[{"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"}],"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"},"required":["in_migration","currency","psp_provider","id","name","billing_address","is_new","email_domain","language"]},"EndCustomerIDPayload":{"type":"object","properties":{"id":{"type":"string","description":"end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["id"]},"EndCustomerInfo":{"type":"object","properties":{"end_customer":{"$ref":"#/components/schemas/EndCustomerWithPSPProvider"},"end_user":{"$ref":"#/components/schemas/EndUser"}},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"}},"required":["end_customer","end_user"]},"EndCustomerInfoUpdate":{"type":"object","properties":{"end_customer":{"$ref":"#/components/schemas/EndCustomerUpdate"},"end_user":{"$ref":"#/components/schemas/EndUserUpdate"}},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"}},"required":["end_customer","end_user"]},"EndCustomerMatcherPayload":{"type":"object","properties":{"company_name":{"type":"string","description":"The End Customer company name","example":"abc123"},"country_code":{"type":"string","description":"The End Customer country code","example":"abc123"},"offer_id":{"type":"string","description":"The Offer Id","example":"abc123"},"type":{"type":"string","description":"Type of the company (required for US)","example":"Partnership","enum":["Sole proprietorship","Partnership","Corporation","Limited Liability Company (LLC)"]},"vat_number":{"type":"string","description":"The End Customer vat number","example":"abc123"}},"description":"User data for matching End Customer","example":{"company_name":"abc123","country_code":"abc123","offer_id":"abc123","type":"Partnership","vat_number":"abc123"},"required":["company_name","offer_id","country_code"]},"EndCustomerStatus":{"type":"object","properties":{"verification_required":{"type":"boolean","description":"whether the user requires end customer verification","example":false}},"example":{"verification_required":false},"required":["verification_required"]},"EndCustomerSummary":{"type":"object","properties":{"available_credit_limit":{"type":"integer","description":"end-customer available credit limit","example":1,"format":"int64"},"comments":{"type":"string","description":"comments about this credit limit set by ops","example":"abc123"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2","example":"DE"},"credit_limit":{"type":"integer","description":"end-customer credit limit","example":1,"format":"int64"},"currency":{"type":"string","description":"end customer currency","example":"abc123"},"email_domain":{"type":"string","description":"end-customer email domain","example":"abc123"},"id":{"type":"string","description":"end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"idv_requirement_status":{"type":"string","description":"end-customer IDV requirement status","example":"abc123"},"language":{"type":"string","description":"end-customer language","example":"abc123"},"name":{"type":"string","description":"end-customer name","example":"abc123"},"psp":{"type":"string","description":"payment service provider","example":"stripe","enum":["stripe","gocardless","stripe_asset_gmbh","none"]},"risk_status":{"type":"string","description":"end-customer risk status","example":"abc123"}},"example":{"available_credit_limit":1,"comments":"abc123","country_code":"DE","credit_limit":1,"currency":"abc123","email_domain":"abc123","id":"739b63c2-9e58-4964-b38d-4ebb424de242","idv_requirement_status":"abc123","language":"abc123","name":"abc123","psp":"stripe","risk_status":"abc123"},"required":["id","name","email_domain","psp","language","country_code"]},"EndCustomerUpdate":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"company_address":{"$ref":"#/components/schemas/Address"},"company_registration_number":{"type":"string","description":"end-customer Company Registration Number","example":"abc123"},"id":{"type":"string","description":"end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"language":{"type":"string","description":"end-customer language (in ISO 639-1 format)","example":"de"},"name":{"type":"string","description":"end-customer name","example":"aa","minLength":1},"not_vat_registered":{"type":"boolean","description":"end-customer declared it has no VAT number","example":false},"tax_number":{"type":"string","description":"end-customer tax number","example":"abc123"},"type":{"type":"string","description":"end-customer type","example":"Partnership","enum":["Sole proprietorship","Partnership","Corporation","Limited Liability Company (LLC)"]},"vat_number":{"type":"string","description":"end-customer VAT number","example":"abc123"}},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"},"required":["name","billing_address"]},"EndCustomerWithPSPProvider":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"company_address":{"$ref":"#/components/schemas/Address"},"company_registration_number":{"type":"string","description":"end-customer Company Registration Number","example":"abc123"},"email_domain":{"type":"string","description":"end-customer email domain","example":"abc123"},"group":{"type":"string","description":"end-customer group","example":"abc123"},"id":{"type":"string","description":"end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"in_migration":{"type":"boolean","description":"is the end-customer currently being migrated","example":false},"is_new":{"type":"boolean","description":"end-customer is new","example":false},"language":{"type":"string","description":"end-customer language","example":"abc123"},"name":{"type":"string","description":"end-customer name","example":"abc123"},"not_vat_registered":{"type":"boolean","description":"end-customer declared it has no VAT number","example":false},"psp_provider":{"type":"string","description":"stripe","example":"abc123"},"risk_status":{"type":"string","description":"end-customer risk status","example":"abc123"},"tax_number":{"type":"string","description":"end-customer tax number","example":"abc123"},"type":{"type":"string","description":"Type of the company (required for US)","example":"Partnership","enum":["Sole proprietorship","Partnership","Corporation","Limited Liability Company (LLC)"]},"vat_number":{"type":"string","description":"end-customer VAT number","example":"abc123"}},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"},"required":["psp_provider","id","name","billing_address","is_new","email_domain","in_migration","language"]},"EndCustomerWithUser":{"type":"object","properties":{"end_customer":{"$ref":"#/components/schemas/EndCustomer"},"end_user":{"$ref":"#/components/schemas/EndUser"}},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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,"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"}},"required":["end_customer","end_user"]},"EndUser":{"type":"object","properties":{"email":{"type":"string","description":"end-user email","example":"abc123"},"first_name":{"type":"string","description":"end-user first name","example":"abc123"},"id":{"type":"string","description":"end-user ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"is_new":{"type":"boolean","description":"end-user is new","example":false},"last_name":{"type":"string","description":"end-user last name","example":"abc123"},"phone_number":{"$ref":"#/components/schemas/PhoneNumber"},"phone_type":{"type":"string","description":"end-user phone type","example":"abc123"}},"example":{"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"},"required":["id","is_new"]},"EndUserUpdate":{"type":"object","properties":{"first_name":{"type":"string","description":"end-user first name","example":"aa","minLength":1},"id":{"type":"string","description":"end-user ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"last_name":{"type":"string","description":"end-user last name","example":"aa","minLength":1},"phone_country_code":{"type":"string","description":"end-user phone country code","example":"abc123"},"phone_national_number":{"type":"string","description":"end-user phone national number","example":"abc123"},"phone_type":{"type":"string","description":"end-user phone type","example":"abc123"}},"example":{"first_name":"aa","id":"739b63c2-9e58-4964-b38d-4ebb424de242","last_name":"aa","phone_country_code":"abc123","phone_national_number":"abc123","phone_type":"abc123"},"required":["first_name","last_name","phone_national_number","phone_country_code"]},"Error":{"type":"object","properties":{"fault":{"type":"boolean","description":"Is the error a server-side fault?","example":false},"id":{"type":"string","description":"ID is a unique identifier for this particular occurrence of the problem.","example":"123abc"},"message":{"type":"string","description":"Message is a human-readable explanation specific to this occurrence of the problem.","example":"parameter 'p' must be an integer"},"name":{"type":"string","description":"Name is the name of this class of errors.","example":"bad_request"},"temporary":{"type":"boolean","description":"Is the error temporary?","example":false},"timeout":{"type":"boolean","description":"Is the error a timeout?","example":false}},"example":{"fault":false,"id":"123abc","message":"parameter 'p' must be an integer","name":"bad_request","temporary":false,"timeout":false},"required":["name","id","message","temporary","timeout","fault"]},"EventPayload":{"type":"object","properties":{"deliveryAttempt":{"type":"integer","description":"The number of times the service has attempted to deliver a message.","example":1,"format":"int64"},"message":{"$ref":"#/components/schemas/MessagePayload"},"subscription":{"type":"string","description":"The subscription name.","example":"abc123"}},"description":"This is the message payload from the PubSub topic.","example":{"deliveryAttempt":1,"message":{"attributes":{"abc123":"abc123"},"data":"abc123","messageId":"abc123","orderingKey":"abc123","publishTime":"abc123"},"subscription":"abc123"}},"ExtendDiscountValidity":{"type":"object","properties":{"valid_from":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"valid_until":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"valid_from":"1970-01-01T00:00:01Z","valid_until":"1970-01-01T00:00:01Z"}},"ExtendDiscountValidityRequestBody":{"type":"object","properties":{"valid_from":{"type":"string","description":"Discount start datetime","example":"1970-01-01T00:00:01Z","format":"date-time"},"valid_until":{"type":"string","description":"Discount end datetime","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"valid_from":"1970-01-01T00:00:01Z","valid_until":"1970-01-01T00:00:01Z"}},"ExtraProductDetails":{"type":"object","properties":{"property":{"type":"string","description":"Name of the property","example":"abc123"},"value":{"type":"string","example":"abc123"}},"example":{"property":"memory","value":"16GB DDR5"},"required":["property","value"]},"FetchAndUpdateTradeInInfoOpsPayload":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the asset trade in","example":"abc123"},"trade_in_id":{"type":"string","description":"The ID of the trade in from the partner","example":"abc123"},"trade_in_product_id":{"type":"string","description":"The product ID from the partner side","example":"abc123"}},"example":{"id":"abc123","trade_in_id":"abc123","trade_in_product_id":"abc123"},"required":["id","trade_in_id","trade_in_product_id"]},"FilteredProductResult":{"type":"object","properties":{"FilteringErrors":{"type":"string","description":"A summary of filtering errors such as disallowed properties","example":"abc123"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"description":"Array of Product","example":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}]},"pagination":{"$ref":"#/components/schemas/CursorPageMetadata"}},"example":{"FilteringErrors":"abc123","data":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}],"pagination":{"has_more":false}},"required":["data","pagination"]},"FilteringOption":{"type":"object","properties":{"operation":{"type":"string","description":"the operation to filter on e.g \u003e","example":"\u003e","enum":["\u003c","\u003e","=","!=","\u003c=","\u003e=","contains","does not contain"]},"property":{"type":"string","description":"the property to filter on e.g title","example":"abc123"},"value":{"type":"string","description":"the value to match","example":"abc123"}},"description":"option for filtering products on the backend","example":{"operation":"\u003e","property":"abc123","value":"abc123"},"required":["property","operation","value"]},"FindTermsAndConditionsLinksRequestBody":{"type":"object","properties":{"params":{"type":"object","properties":{"language":{"type":"string","description":"Language of the terms and conditions links","example":"abc123"}},"example":{"language":"abc123"}}},"example":{"params":{"language":"abc123"}}},"FirstPartyService":{"type":"object","properties":{"additional_values":{"$ref":"#/components/schemas/FirstPartyServiceAdditionalValues"},"id":{"type":"string","description":"The internal Id for the first party service","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"monthly_price":{"$ref":"#/components/schemas/MoneyAmount"},"type":{"type":"string","example":"topi_replace","enum":["topi_repair","topi_replace","demo_first_party_service","topi_accessory","topi_data_deletion_certificate","topi_care_plus_synaxon","topi_care_plus_michaelag"]}},"description":"Info for first party service","example":{"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"},"required":["id","type","monthly_price","additional_values"]},"FirstPartyServiceAdditionalValues":{"type":"object","properties":{"accessory_type":{"type":"string","description":"if the first party service is an accessory, this value is the kind of the accessory","example":"experiment_charger"},"deductible_price":{"$ref":"#/components/schemas/MoneyAmountWithOptionalGross"},"images":{"$ref":"#/components/schemas/FirstPartyServiceImages"}},"description":"Additional values for specific first party types.","example":{"accessory_type":"experiment_charger","deductible_price":{"currency":"EUR","gross":119000,"net":100000},"images":{"url1x":"abc123","url2x":"abc123","url3x":"abc123"}}},"FirstPartyServiceImages":{"type":"object","properties":{"url1x":{"type":"string","description":"URL to redirect to on success","example":"abc123"},"url2x":{"type":"string","description":"URL to redirect to on success","example":"abc123"},"url3x":{"type":"string","description":"URL to redirect to on success","example":"abc123"}},"example":{"url1x":"abc123","url2x":"abc123","url3x":"abc123"},"required":["url1x","url2x","url3x"]},"FirstPartyServiceProductOverride":{"type":"object","properties":{"additional_values":{"$ref":"#/components/schemas/FirstPartyServiceAdditionalValues"},"disabled":{"type":"boolean","description":"If the service should be disabled for a given product","example":false},"monthly_price":{"$ref":"#/components/schemas/MoneyAmount"},"product_id":{"type":"string","description":"The internal ID for the product","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"type":{"type":"string","example":"topi_replace","enum":["topi_repair","topi_replace","demo_first_party_service","topi_accessory","topi_data_deletion_certificate","topi_care_plus_synaxon","topi_care_plus_michaelag"]}},"description":"First Party Service override information for a product ","example":{"additional_values":{"accessory_type":"experiment_charger","deductible_price":{"currency":"EUR","gross":119000,"net":100000},"images":{"url1x":"abc123","url2x":"abc123","url3x":"abc123"}},"disabled":false,"monthly_price":{"currency":"EUR","gross":119000,"net":100000},"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"topi_replace"},"required":["product_id","type","disabled"]},"GetIDVerificationResult":{"type":"object","properties":{"url":{"type":"string","description":"The URL to the ID verification flow","example":"abc123"}},"example":{"url":"abc123"},"required":["url"]},"Headroom":{"type":"object","properties":{"expected_residual_value_ratio":{"type":"number","description":"Expected residual value ratio for this tenure","example":1,"format":"double"},"headroom_ratio":{"type":"number","description":"Headroom ratio applied to this product for this tenure","example":1,"format":"double"},"is_default":{"type":"boolean","description":"Whether this tenure is the default tenure","example":false},"tenure":{"type":"integer","description":"The tenure in months (6, 12, 24, or 36)","example":1,"format":"int64"}},"example":{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1},"required":["is_default","tenure","headroom_ratio","expected_residual_value_ratio"]},"IDList":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","example":"abc123"},"description":"The ids of products","example":["abc123"]}},"example":{"ids":["abc123"]},"required":["ids"]},"IDListShippingMethod":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","example":"abc123"},"description":"The ids to mark as supported","example":["abc123"]}},"example":{"ids":["abc123"]},"required":["ids"]},"IDVerification":{"type":"object","properties":{"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"decision_id":{"type":"string","description":"Decision ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"end_customer_id":{"type":"string","description":"EndCustomer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"finalized_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"id":{"type":"string","description":"ID verification ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"offer_id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"provenir_id":{"type":"string","description":"Provenir ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"source":{"type":"string","description":"The ID verification source name, e.g. idenfy","example":"abc123"},"source_id":{"type":"string","description":"The ID verification ID on provider side","example":"abc123"},"status":{"type":"string","description":"The status of the ID verification flow","example":"abc123"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"url":{"type":"string","description":"The URL to the ID verification flow","example":"abc123"},"user_id":{"type":"string","description":"User ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"created_at":"1970-01-01T00:00:01Z","decision_id":"739b63c2-9e58-4964-b38d-4ebb424de242","end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","finalized_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","provenir_id":"739b63c2-9e58-4964-b38d-4ebb424de242","source":"abc123","source_id":"abc123","status":"abc123","updated_at":"1970-01-01T00:00:01Z","url":"abc123","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["id","user_id","end_customer_id","provenir_id","offer_id","decision_id","source","source_id","status","url","created_at","updated_at"]},"IDVerificationURL":{"type":"object","properties":{"url":{"type":"string","description":"The URL to the ID verification flow","example":"abc123"}},"example":{"url":"abc123"},"required":["url"]},"ImportProductsRequestBody":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/AddProduct"},"description":"Product payload","example":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"image":{"url":"https://example.com/foo"},"is_active":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"},{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"image":{"url":"https://example.com/foo"},"is_active":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}],"minItems":1}},"example":{"products":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"image":{"url":"https://example.com/foo"},"is_active":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"},{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"image":{"url":"https://example.com/foo"},"is_active":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}]},"required":["products"]},"ImportResult":{"type":"object","properties":{"id":{"type":"string","description":"The id of the import processing","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"status":{"type":"string","description":"The current import status","example":"started","enum":["created","started","completed","failed"]},"summary":{"$ref":"#/components/schemas/SummaryInfo"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","status":"started","summary":{"sample_products_rejected":[{"error_code":"abc123","error_description":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"}}],"total_products":1,"total_products_imported":1,"total_products_rejected":1}},"required":["id","status"]},"IngestByProductIDsPayload":{"type":"object","properties":{"csv_import":{"type":"string","description":"Base64 encoded CSV containing asset IDs and trade in product IDs","example":"abc123"},"provider_id":{"type":"string","description":"Trade-in provider ID","example":"abc123"}},"description":"Payload ingesting trade in product IDs","example":{"csv_import":"abc123","provider_id":"abc123"},"required":["csv_import","provider_id"]},"IngestByProductIDsResult":{"type":"object","properties":{"failed_count":{"type":"integer","description":"how many items are failed to ingest","example":1,"format":"int64"},"failed_items":{"type":"array","items":{"$ref":"#/components/schemas/UnsuccessfulProductIDIngestion"},"description":"A list of failed product ID ingestions","example":[{"line_number":1,"reason":"abc123"}]},"skipped_count":{"type":"integer","description":"how many items are skipped to ingest","example":1,"format":"int64"},"skipped_items":{"type":"array","items":{"$ref":"#/components/schemas/UnsuccessfulProductIDIngestion"},"description":"A list of skipped product ID ingestions","example":[{"line_number":1,"reason":"abc123"}]},"succeeded_count":{"type":"integer","description":"how many items are successfully ingested","example":1,"format":"int64"},"total_count":{"type":"integer","description":"how many items are in the CSV","example":1,"format":"int64"}},"example":{"failed_count":1,"failed_items":[{"line_number":1,"reason":"abc123"}],"skipped_count":1,"skipped_items":[{"line_number":1,"reason":"abc123"}],"succeeded_count":1,"total_count":1},"required":["failed_count","failed_items","skipped_count","skipped_items","succeeded_count","total_count"]},"InvalidDiscountCodeError":{"type":"object","properties":{"message":{"type":"string","description":"Discount code error message","example":"abc123"},"type":{"type":"string","example":"not_new_end_customer","enum":["generic","not_new_end_customer"]}},"description":"Errors for discount code validation","example":{"message":"abc123","type":"not_new_end_customer"},"required":["message","type"]},"InviteByEmailPayload":{"type":"object","properties":{"email":{"type":"string","description":"email to invite","example":"abc123"}},"example":{"email":"abc123"},"required":["email"]},"InvoiceInfo":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/MoneyAmount"},"contract_type":{"type":"string","description":"Different contracts type","example":"rent","enum":["pay_now","rent"]},"encrypted_invoice_number":{"type":"string","description":"Unique encrypted Invoice Number","example":"abc123"},"order_id":{"type":"string","description":"topi order ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"transaction_type":{"type":"string","description":"Type of the transaction. Credit note means that the customer is credited.","default":"invoice","example":"invoice","enum":["invoice","credit_note"]},"withdrawal_date":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"amount":{"currency":"EUR","gross":119000,"net":100000},"contract_type":"rent","encrypted_invoice_number":"abc123","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","transaction_type":"invoice","withdrawal_date":"1970-01-01T00:00:01Z"},"required":["encrypted_invoice_number","order_id","amount"]},"InvoicePayload":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/MoneyAmount"},"confirm_overwrite":{"type":"boolean","description":"Confirm that the invoice will be overwritten if it already exists.","example":false},"contract_type":{"type":"string","description":"Different contracts type","example":"rent","enum":["pay_now","rent"]},"duration":{"type":"integer","description":"The duration in months","example":6,"enum":[0,6,12,24,30,36,48],"format":"int64"},"encrypted_invoice_number":{"type":"string","description":"Unique encrypted Invoice Number","example":"abc123"},"file":{"type":"string","description":"Base64 encoded string containing the invoice","example":"abc123"},"invoice_date":{"type":"string","description":"The date of the invoice","example":"abc123"},"order_id":{"type":"string","description":"topi order ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for the offer related with this invoice","example":"abc123"},"transaction_type":{"type":"string","description":"Type of the transaction. Credit note means that the customer is credited.","default":"invoice","example":"invoice","enum":["invoice","credit_note"]},"withdrawal_date":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"amount":{"currency":"EUR","gross":119000,"net":100000},"confirm_overwrite":false,"contract_type":"rent","duration":6,"encrypted_invoice_number":"abc123","file":"abc123","invoice_date":"abc123","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","transaction_type":"invoice","withdrawal_date":"1970-01-01T00:00:01Z"},"required":["file","invoice_date","encrypted_invoice_number","order_id","amount"]},"IsInStorePickupRequestBody":{"type":"object","properties":{"isInStorePickup":{"type":"boolean","example":false}},"example":{"isInStorePickup":false},"required":["isInStorePickup"]},"ItemSummary":{"type":"object","properties":{"identifier":{"type":"string","description":"Identifier of the item.","example":"abc123"},"pay_now":{"$ref":"#/components/schemas/PayNow"},"pay_now_excluding_sublines":{"$ref":"#/components/schemas/PayNow"},"rent":{"type":"array","items":{"$ref":"#/components/schemas/Rent"},"description":"The unit rent amount per item for all rental durations.","example":[{"duration":12,"monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}]},"rent_excluding_sublines":{"type":"array","items":{"$ref":"#/components/schemas/Rent"},"description":"The unit rent amount per item for all rental durations for main line only.","example":[{"duration":12,"monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}]},"total_pay_now":{"$ref":"#/components/schemas/PayNow"},"total_rent":{"type":"array","items":{"$ref":"#/components/schemas/Rent"},"description":"The total rent amount per item for all rental durations.","example":[{"duration":12,"monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}]}},"example":{"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}}]},"required":["identifier","rent","pay_now","total_rent","total_pay_now","rent_excluding_sublines","pay_now_excluding_sublines"]},"ListFilteredRequestBody":{"type":"object","properties":{"filteringOptions":{"type":"array","items":{"$ref":"#/components/schemas/FilteringOption"},"example":[{"operation":"\u003e","property":"abc123","value":"abc123"}]}},"example":{"filteringOptions":[{"operation":"\u003e","property":"abc123","value":"abc123"}]}},"MergeEndCustomerPayload":{"type":"object","properties":{"destination_id":{"type":"string","description":"Destination end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"source_id":{"type":"string","description":"Source end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"destination_id":"739b63c2-9e58-4964-b38d-4ebb424de242","source_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["source_id","destination_id"]},"MessagePayload":{"type":"object","properties":{"attributes":{"type":"object","description":"Attributes of the message.","example":{"abc123":"abc123"},"additionalProperties":{"type":"string","example":"abc123"}},"data":{"type":"string","description":"Base64 data body.","example":"abc123"},"messageId":{"type":"string","description":"The message ID.","example":"abc123"},"orderingKey":{"type":"string","description":"The ordering key of the message.","example":"abc123"},"publishTime":{"type":"string","description":"The time at which the message was published.","example":"abc123"}},"example":{"attributes":{"abc123":"abc123"},"data":"abc123","messageId":"abc123","orderingKey":"abc123","publishTime":"abc123"},"required":["data"]},"MigrateUserPayload":{"type":"object","properties":{"destination_id":{"type":"string","description":"Destination end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"source_id":{"type":"string","description":"Source end-customer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"destination_id":"739b63c2-9e58-4964-b38d-4ebb424de242","source_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["destination_id"]},"MoneyAmount":{"type":"object","properties":{"currency":{"type":"string","description":"Currency code, see ISO 4127 (https://www.iso.org/iso-4217-currency-codes.html) (supported: EUR, GBP, USD)","example":"EUR"},"gross":{"type":"integer","description":"Gross amount of money, expressed in the minor unit for the currency","example":119000,"format":"int64"},"net":{"type":"integer","description":"Net amount of money, expressed in the minor unit for the currency","example":100000,"format":"int64"}},"example":{"currency":"EUR","gross":119000,"net":100000},"required":["gross","net","currency"]},"MoneyAmountWithOptionalGross":{"type":"object","properties":{"currency":{"type":"string","description":"Currency code, see ISO 4127 (https://www.iso.org/iso-4217-currency-codes.html) (supported: EUR, GBP, USD)","example":"EUR"},"gross":{"type":"integer","description":"Gross amount of money, expressed in the minor unit for the currency","example":119000,"format":"int64"},"net":{"type":"integer","description":"Net amount of money, expressed in the minor unit for the currency","example":100000,"format":"int64"}},"example":{"currency":"EUR","gross":119000,"net":100000},"required":["net","currency"]},"MoneyAmountWithOptionalTax":{"type":"object","properties":{"currency":{"type":"string","description":"Currency code, see ISO 4127 (https://www.iso.org/iso-4217-currency-codes.html) (supported: EUR, GBP, USD)","example":"EUR"},"gross":{"type":"integer","description":"Gross amount of money, expressed in the minor unit for the currency","example":119000,"format":"int64"},"net":{"type":"integer","description":"Net amount of money, expressed in the minor unit for the currency","example":100000,"format":"int64"},"tax_rate":{"type":"integer","description":"Tax rate, expressed in the the rate multiplied by 10,000. Example for 21.5%: `0.215 * 10000 = 2150`","example":1900,"format":"int64"}},"example":{"currency":"EUR","gross":119000,"net":100000,"tax_rate":1900},"required":["gross","net","currency"]},"MoneyAmountWithRequiredTax":{"type":"object","properties":{"currency":{"type":"string","description":"Currency code, see ISO 4127 (https://www.iso.org/iso-4217-currency-codes.html) (supported: EUR, GBP, USD)","example":"EUR"},"gross":{"type":"integer","description":"Gross amount of money, expressed in the minor unit for the currency","example":119000,"format":"int64"},"net":{"type":"integer","description":"Net amount of money, expressed in the minor unit for the currency","example":100000,"format":"int64"},"tax_rate":{"type":"integer","description":"Tax rate, expressed in the the rate multiplied by 10,000. Example for 21.5%: `0.215 * 10000 = 2150`","example":1900,"format":"int64"}},"example":{"currency":"EUR","gross":119000,"net":100000,"tax_rate":1900},"required":["tax_rate","gross","net","currency"]},"MoneyValue":{"type":"object","properties":{"amount":{"type":"integer","description":"money amount, expressed in the minor unit for the currency","example":34000,"format":"int64"},"currency":{"type":"string","description":"Currency code, see ISO 4127 (https://www.iso.org/iso-4217-currency-codes.html) (supported: EUR, GBP, USD)","example":"EUR"}},"example":{"amount":34000,"currency":"EUR"},"required":["amount","currency"]},"MoveOffersToSellerOpsRequestBody":{"type":"object","properties":{"destination_seller_id":{"type":"string","description":"the seller ID the offers should be moved to","example":"abc123"},"offer_ids":{"type":"array","items":{"type":"string","example":"abc123"},"description":"list of offer IDs to move","example":["abc123","abc123"],"minItems":1}},"example":{"destination_seller_id":"abc123","offer_ids":["abc123","abc123"]},"required":["offer_ids"]},"MoveOffersToSellerOpsResponseBody":{"type":"object","properties":{"moved_offers":{"type":"integer","description":"number of offers updated","example":1,"format":"int64"},"moved_orders":{"type":"integer","description":"number of associated orders updated","example":1,"format":"int64"},"moved_sales_agents":{"type":"integer","description":"number of associated sales agents updated","example":1,"format":"int64"}},"example":{"moved_offers":1,"moved_orders":1,"moved_sales_agents":1},"required":["moved_offers","moved_orders","moved_sales_agents"]},"NewContractTermItem":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/ContractTermItemPayload"},"type":{"type":"string","description":"Different contracts type","example":"rent","enum":["pay_now","rent"]}},"example":{"payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"},"required":["type","payload"]},"NewContractTerms":{"type":"object","properties":{"contract_terms":{"type":"array","items":{"$ref":"#/components/schemas/NewContractTermItem"},"description":"New contract Terms ","example":[{"payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}]},"default_contract_term":{"$ref":"#/components/schemas/RentTenure"},"rent":{"$ref":"#/components/schemas/NewRentContractTerm"}},"example":{"contract_terms":[{"payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}],"default_contract_term":{"duration":6},"rent":{"duration":6,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}}}},"NewOfferLineCategoriesPayload":{"type":"object","properties":{"offer_line_categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoriesByOfferLine"},"example":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","pricing_category":"iphone_17_pro"}]}},"description":"The categories to set by offer line","example":{"offer_line_categories":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","pricing_category":"iphone_17_pro"}]},"required":["offer_line_categories"]},"NewPolicyStep":{"type":"object","properties":{"interval_days":{"type":"integer","description":"Number of days until reminder is triggered","example":1,"format":"int64"},"is_recurring":{"type":"boolean","description":"If step is recurring","example":false},"step_number":{"type":"integer","description":"Step number","example":1,"format":"int64"}},"example":{"interval_days":1,"is_recurring":false,"step_number":1},"required":["step_number","interval_days","is_recurring"]},"NewPortalAgent":{"type":"object","properties":{"email":{"type":"string","description":"E-mail","example":"alice@example.com","format":"email"},"external_agent_id":{"type":"string","description":"Id number used to identify the sales agent in the seller's internal system","example":"abc123"},"name":{"type":"string","description":"Name of the agent","example":"abc123"},"phone":{"type":"string","description":"Phone number","example":"abc123"},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_store_id":{"type":"string","description":"Id number used to identify the store a PoS agent is operating from","example":"abc123"},"topi_relevant":{"type":"boolean","description":"Whether the user is relevant for driving topi GMV, this allows us to opt out users that are managers or are not expected to do much sales from reporting.","default":true,"example":false}},"example":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123","topi_relevant":false},"required":["name","phone","email"]},"NewPortalBulkAgents":{"type":"object","properties":{"new_agents":{"type":"array","items":{"$ref":"#/components/schemas/CommonPortalAgent"},"description":"List con agents to add.","example":[{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123"}]}},"example":{"new_agents":[{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123"}]}},"NewPricingCategory":{"type":"object","properties":{"description":{"type":"string","description":"description of the pricing category","example":"abc123"},"headrooms":{"type":"array","items":{"$ref":"#/components/schemas/Headroom"},"description":"the headrooms for the pricing category","example":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}]},"identifier":{"type":"string","description":"name of the pricing category","example":"abc123"},"services":{"type":"array","items":{"$ref":"#/components/schemas/NewPricingCategoryService"},"description":"the services for the pricing category","example":[{"name":"abc123","service_prices":[{"kind":"abc123","price":1,"tenure":1}]}]}},"example":{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"identifier":"abc123","services":[{"name":"abc123","service_prices":[{"kind":"abc123","price":1,"tenure":1}]}]},"required":["identifier","headrooms","services"]},"NewPricingCategoryInfo":{"type":"object","properties":{"asset_id_prefix":{"type":"string","description":"description of the pricing category","example":"abc123"},"asset_reference":{"type":"string","description":"the headrooms for the pricing category","example":"abc123"},"asset_title":{"type":"string","description":"the services for the pricing category","example":"abc123"},"replace_title":{"type":"boolean","description":"should replace the title","example":false},"service_type":{"type":"string","description":"name of the pricing category","example":"abc123"}},"example":{"asset_id_prefix":"abc123","asset_reference":"abc123","asset_title":"abc123","replace_title":false,"service_type":"abc123"},"required":["service_type","asset_id_prefix","asset_reference","asset_title","replace_title"]},"NewPricingCategoryService":{"type":"object","properties":{"name":{"type":"string","description":"name of the service","example":"abc123"},"service_prices":{"type":"array","items":{"$ref":"#/components/schemas/NewPricingCategoryServicePrice"},"description":"the prices for the service per tenure","example":[{"kind":"abc123","price":1,"tenure":1}]}},"example":{"name":"abc123","service_prices":[{"kind":"abc123","price":1,"tenure":1}]},"required":["name","service_prices"]},"NewPricingCategoryServicePrice":{"type":"object","properties":{"kind":{"type":"string","description":"the price of the service price","example":"abc123"},"price":{"type":"number","description":"price of the service for this tenure","example":1,"format":"double"},"tenure":{"type":"integer","description":"the tenure for this price","example":1,"format":"int64"}},"example":{"kind":"abc123","price":1,"tenure":1},"required":["kind","tenure"]},"NewPricingCategoryServicePrices":{"type":"object","properties":{"id":{"type":"string","description":"topi service ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"service_prices":{"type":"array","items":{"$ref":"#/components/schemas/ServicePriceUpdate"},"description":"the prices for the service per tenure","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","price":1}]}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","price":1}]},"required":["id","service_prices"]},"NewRentContractTerm":{"type":"object","properties":{"duration":{"type":"integer","description":"The duration in months","example":6,"enum":[0,6,12,24,30,36,48],"format":"int64"},"id":{"type":"string","description":"The internal Id for the contract term","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"monthly_amount":{"$ref":"#/components/schemas/MoneyAmount"}},"example":{"duration":6,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}},"required":["monthly_amount","duration"]},"NotifyUsersByEmailPayload":{"type":"object","properties":{"email_list":{"type":"array","items":{"type":"string","example":"abc123"},"description":"The list of emails to send the email to","example":["abc123"]},"language":{"type":"string","example":"en","enum":["de","en","nl"]},"template_name":{"type":"string","description":"the corresponding template name on SendGrid","example":"abc123"}},"example":{"email_list":["abc123"],"language":"en","template_name":"abc123"},"required":["template_name","email_list","language"]},"NotifyUsersByEmailResult":{"type":"object","properties":{"failed_count":{"type":"integer","description":"Number of failed email deliveries.","example":1,"format":"int64"},"failed_emails":{"type":"array","items":{"type":"string","example":"abc123"},"description":"List of email addresses that failed to send.","example":["abc123"]},"succeeded_count":{"type":"integer","description":"Number of successfully sent emails.","example":1,"format":"int64"},"total_count":{"type":"integer","description":"Total number of emails attempted to send.","example":1,"format":"int64"}},"example":{"failed_count":1,"failed_emails":["abc123"],"succeeded_count":1,"total_count":1},"required":["failed_count","failed_emails","succeeded_count","total_count"]},"OauthPayload":{"type":"object","properties":{"oauth_token":{"type":"string","description":"OAuth2 access token used to perform authorization","example":"abc123"}},"example":{"oauth_token":"abc123"},"required":["oauth_token"]},"Offer":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/SalesAgent"},"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerInfo"},"declined_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"exit_redirect":{"type":"string","description":"URL to redirect to on error","example":"abc123"},"expires_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OfferLine"},"description":"Product lines","example":[{"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":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"offer_link":{"type":"string","example":"abc123"},"phone_number":{"type":"string","description":"Phone number","example":"abc123"},"redirect_to_superseding_offer_url":{"type":"string","description":"link to the top-most offer in the superseding chain","example":"abc123"},"sales_channel":{"type":"string","example":"ecommerce","enum":["telesales","ecommerce"]},"seller_info":{"$ref":"#/components/schemas/SellerInfo"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"shipping":{"$ref":"#/components/schemas/ShippingInfo"},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"status":{"type":"string","example":"voided","enum":["created","voided","accepted","expired","rejected","pending_review","declined"]},"success_redirect":{"type":"string","description":"URL to redirect to on success","example":"abc123"},"superseded_by_id":{"type":"string","description":"ID of the offer that superseded this one (when voided)","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"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"},"company_registration_number":"123456789","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","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","phone_number":"abc123","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"},"required":["id","customer","status","seller_info","created_at","lines","shipping_address","sales_channel","expires_at","seller_offer_reference"]},"OfferForEndCustomer":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/SalesAgent"},"allowed_billing_countries":{"type":"array","items":{"type":"string","example":"abc123"},"description":"List of allowed billing country codes for this offer (derived from the contractual entity)","example":["abc123"]},"contractual_entity":{"type":"string","description":"The contractual entity that will fulfil this offer","example":"abc123"},"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerInfo"},"declined_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"exit_redirect":{"type":"string","description":"URL to redirect to on error","example":"abc123"},"expires_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"has_single_term_duration":{"type":"boolean","description":"Whether all rental line items must share a single term duration (derived from the contractual entity)","example":false},"id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OfferLine"},"description":"Product lines","example":[{"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":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"offer_link":{"type":"string","example":"abc123"},"payment_method_required":{"type":"boolean","description":"Whether the checkout must collect a payment method (derived from the offer's contractual entity server-side)","example":false},"phone_number":{"type":"string","description":"Phone number","example":"abc123"},"pricing_overview":{"$ref":"#/components/schemas/PricingOverview"},"redirect_to_superseding_offer_url":{"type":"string","description":"link to the top-most offer in the superseding chain","example":"abc123"},"sales_channel":{"type":"string","example":"ecommerce","enum":["telesales","ecommerce"]},"seller_info":{"$ref":"#/components/schemas/SellerInfo"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"shipping":{"$ref":"#/components/schemas/ShippingInfo"},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"status":{"type":"string","example":"voided","enum":["created","voided","accepted","expired","rejected","pending_review","declined"]},"success_redirect":{"type":"string","description":"URL to redirect to on success","example":"abc123"},"superseded_by_id":{"type":"string","description":"ID of the offer that superseded this one (when voided)","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"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"},"company_registration_number":"123456789","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"},"required":["pricing_overview","payment_method_required","contractual_entity","has_single_term_duration","allowed_billing_countries","id","customer","status","seller_info","created_at","lines","shipping_address","sales_channel","expires_at","seller_offer_reference"]},"OfferForOps":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/SalesAgent"},"contract_values":{"$ref":"#/components/schemas/OfferStatsContractValues"},"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerInfo"},"declined_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"exit_redirect":{"type":"string","description":"URL to redirect to on error","example":"abc123"},"expires_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OfferLine"},"description":"Product lines","example":[{"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":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"offer_link":{"type":"string","example":"abc123"},"order_id":{"type":"string","description":"Order ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"phone_number":{"type":"string","description":"Phone number","example":"abc123"},"redirect_to_superseding_offer_url":{"type":"string","description":"link to the top-most offer in the superseding chain","example":"abc123"},"rejection_reason":{"type":"string","description":"Rejection reason, if the offer was rejected","example":"abc123"},"sales_channel":{"type":"string","example":"ecommerce","enum":["telesales","ecommerce"]},"seller_info":{"$ref":"#/components/schemas/SellerInfo"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"shipping":{"$ref":"#/components/schemas/ShippingInfo"},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"status":{"type":"string","example":"voided","enum":["created","voided","accepted","expired","rejected","pending_review","declined"]},"success_redirect":{"type":"string","description":"URL to redirect to on success","example":"abc123"},"superseded_by_id":{"type":"string","description":"ID of the offer that superseded this one (when voided)","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"total_assets":{"type":"integer","description":"amount of assets in the offer: sum(lines.quantity)","example":1,"format":"int64"},"total_lines":{"type":"integer","description":"amount of line items in the offer","example":1,"format":"int64"},"total_lines_leasable":{"type":"integer","description":"amount of rentable line items","example":1,"format":"int64"},"total_lines_rentable":{"type":"integer","description":"amount of rentable line items","example":1,"format":"int64"},"total_value":{"$ref":"#/components/schemas/MoneyAmount"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"user_id":{"type":"string","description":"User ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"agent":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"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"},"company_registration_number":"123456789","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","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","order_id":"739b63c2-9e58-4964-b38d-4ebb424de242","phone_number":"abc123","redirect_to_superseding_offer_url":"abc123","rejection_reason":"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","total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["id","customer","status","seller_info","created_at","lines","shipping_address","sales_channel","expires_at","seller_offer_reference","total_lines","total_assets","total_value"]},"OfferIDPayload":{"type":"object","properties":{"id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["id"]},"OfferIDVRequirement":{"type":"object","properties":{"result":{"type":"string","example":"not_required","enum":["required","not_required","pending"]}},"example":{"result":"not_required"},"required":["result"]},"OfferLine":{"type":"object","properties":{"applied_discount_id":{"type":"string","description":"The ID of any discount applied to the offer line","example":"abc123"},"available_contract_terms":{"$ref":"#/components/schemas/ContractTerms"},"available_first_party_services":{"type":"array","items":{"$ref":"#/components/schemas/FirstPartyService"},"description":"Available first party services for the product","example":[{"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":{"$ref":"#/components/schemas/MoneyAmountWithOptionalGross"},"contract_terms_list":{"type":"array","items":{"$ref":"#/components/schemas/ContractTermItem"},"description":"Available terms for the product","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}]},"id":{"type":"string","description":"The offer line Id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"pretty_id":{"type":"string","description":"The pretty ID of the product","example":"abc123"},"price":{"$ref":"#/components/schemas/MoneyAmount"},"pricing_category":{"type":"string","description":"The topi-assigned pricing category for the product","example":"legacy_phone_24","enum":["legacy_laptop_36","legacy_phone_24","iphone_17","iphone_17_pro","iphone_17_pro_max","iphone_air","iphone_17_e","iphone_16_pro_max","iphone_16_pro","iphone_16_plus","iphone_16","iphone_15_pro_max","iphone_15_pro","iphone_15_plus","iphone_15","iphone_14_pro_max","iphone_14_pro","iphone_14_plus","iphone_14","iphone_13_pro_max","iphone_13_pro","iphone_13","iphone_13_mini","iphone_12_pro_max","iphone_12_pro","iphone_12","iphone_12_mini","iphone_11","iphone_se_22","iphone_se_20","macbook_pro_13_14","macbook_pro_13_14_m3","macbook_pro_13_14_m4","macbook_pro_13_14_m5","macbook_pro_15_16","macbook_pro_15_16_m3","macbook_pro_15_16_m4","macbook_pro_15_16_m5","macbook_air","macbook_air_13_m5","macbook_air_15_m5","macbook_neo","mac_desktop","mac_desktop_m4","mac_studio","mac_studio_m3m4","mac_pro_m2","apple_display","studio_display_2026","studio_display_2022","studio_display_xdr","ipad_pro","ipad_pro_m5","ipad_pro_m4","ipad_pro_12_9_inch_7_gen","ipad_pro_12_9_inch_6_gen","ipad_pro_12_9_inch_5_gen","ipad_pro_12_9_inch_4_gen","ipad_pro_12_9_inch_3_gen","ipad_pro_12_9_inch_2_gen","ipad_pro_12_9_inch_1_gen","ipad_pro_11_inch_4_gen","ipad_pro_11_inch_3_gen","ipad_pro_11_inch_2_gen","ipad_pro_11_inch_1_gen","ipad_pro_10_5_inch","ipad_air","ipad_air_m4","ipad_air_m3","ipad_air_6_gen","ipad_air_5_gen","ipad_air_4_gen","ipad_air_3_gen","ipad_air_2_gen","ipad_air_1_gen","ipad_regular","ipad_regular_11_gen","ipad_regular_10_gen","ipad_regular_9_gen","ipad_regular_8_gen","ipad_regular_7_gen","ipad_regular_6_gen","ipad_regular_5_gen","ipad_mini","ipad_mini_6_gen","ipad_mini_5_gen","ipad_mini_4_gen","ipad_mini_3_gen","ipad_mini_2_gen","ipad_mini_1_gen","smartwatch_apple","smartwatch_apple_ultra","smartwatch_other","laptop_other_top","laptop_other_low","desktop_other_top","desktop_other_low","phone_other_top","phone_other_low","tablet_other_top","tablet_other_low","screen","accessory_other","accessory_airpods","accessory_pencil","accessory_homepod","accessory_visionpro","services_insurance","software","services_management","other","bundle","second_hand","sandbox_supported_product","printer","iphone_16_e","server","network_security","mac_pro","mac_studio_m3","mac_studio_m4","accessory_smartfolio","accessory_appletv","accessory_gpu",""]},"product_id":{"type":"string","description":"Product ID inside Topi catalog","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"quantity":{"type":"integer","description":"Amount of products","example":1,"format":"int64"},"requires_serial_number":{"type":"boolean","description":"Does the offerline require a serial number","example":false},"selected_contract_terms_id":{"type":"string","description":"Selected term id","example":"abc123"},"selected_first_party_service_ids":{"type":"array","items":{"type":"string","example":"abc123"},"description":"Selected first party services ids","example":["abc123"]},"seller_product_provided_by":{"type":"string","description":"Who the ultimate provider for the product is","example":"abc123"},"seller_product_references":{"type":"array","items":{"$ref":"#/components/schemas/SellerProductReference"},"description":"Partner's own reference for this product","example":[{"reference":"123ab-5343","source":"sap"}]},"seller_product_type":{"type":"string","example":"software","enum":["hardware","software","service","hardware_built_to_order"]},"sublines":{"type":"array","items":{"$ref":"#/components/schemas/BaseOfferLineResult"},"description":"Service items that are bundled with this main offer line.\n\t\tSublines represent additional services or components that are tied to the main product line (e.g., installation services, technical support).\n\t\t\n\t\tBusiness Rules:\n\t\t- Sublines can only be attached to hardware or accessory main lines\n\t\t- Sublines must be service-category products\n\t\t- Sublines inherit the same quantity and contract term duration as their parent line\n\t\t- Each subline maintains a trackable relationship to its parent line\n\t\t- Pricing calculations include both individual subline costs and combined totals\n\t\t\n\t\tExample: A phone (main line) with screen protection service (subline)","example":[{"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":{"type":"string","description":"The product subtitle","example":"abc123"},"title":{"type":"string","description":"The product name","example":"abc123"}},"example":{"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"},"required":["id","quantity","price","seller_product_references","title"]},"OfferLinePayload":{"type":"object","properties":{"available_contract_terms":{"$ref":"#/components/schemas/ContractTerms"},"available_first_party_services":{"type":"array","items":{"$ref":"#/components/schemas/FirstPartyService"},"description":"Available first party services for the product","example":[{"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":{"$ref":"#/components/schemas/MoneyAmountWithOptionalGross"},"contract_terms_list":{"type":"array","items":{"$ref":"#/components/schemas/ContractTermItem"},"description":"Available terms for the product","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","payload":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"type":"rent"}]},"pretty_id":{"type":"string","description":"The pretty ID of the product","example":"abc123"},"price":{"$ref":"#/components/schemas/MoneyAmount"},"product_id":{"type":"string","description":"Product ID inside Topi catalog","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"quantity":{"type":"integer","description":"Amount of products","example":1,"format":"int64"},"requires_serial_number":{"type":"boolean","description":"Does the offerline require a serial number","example":false},"selected_contract_terms_id":{"type":"string","description":"Selected term id","example":"abc123"},"selected_first_party_service_ids":{"type":"array","items":{"type":"string","example":"abc123"},"description":"Selected first party services ids","example":["abc123"]},"seller_product_references":{"type":"array","items":{"$ref":"#/components/schemas/SellerProductReference"},"description":"Partner's own reference for this product","example":[{"reference":"123ab-5343","source":"sap"}]},"subtitle":{"type":"string","description":"The product subtitle","example":"abc123"},"title":{"type":"string","description":"The product name","example":"abc123"}},"example":{"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"}],"pretty_id":"abc123","price":{"currency":"EUR","gross":119000,"net":100000},"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_references":[{"reference":"123ab-5343","source":"sap"}],"subtitle":"abc123","title":"abc123"},"required":["requires_serial_number","quantity","price","seller_product_references","title"]},"OfferStats":{"type":"object","properties":{"contract_values":{"$ref":"#/components/schemas/OfferStatsContractValues"},"total_assets":{"type":"integer","description":"amount of assets in the offer: sum(lines.quantity)","example":1,"format":"int64"},"total_lines":{"type":"integer","description":"amount of line items in the offer","example":1,"format":"int64"},"total_lines_leasable":{"type":"integer","description":"amount of rentable line items","example":1,"format":"int64"},"total_lines_rentable":{"type":"integer","description":"amount of rentable line items","example":1,"format":"int64"},"total_value":{"$ref":"#/components/schemas/MoneyAmount"}},"example":{"contract_values":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]},"total_assets":1,"total_lines":1,"total_lines_leasable":1,"total_lines_rentable":1,"total_value":{"currency":"EUR","gross":119000,"net":100000}},"required":["total_lines","total_assets","total_value"]},"OfferStatsContractValues":{"type":"object","properties":{"pay_now":{"$ref":"#/components/schemas/OfferStatsPayNow"},"rent":{"type":"array","items":{"$ref":"#/components/schemas/OfferStatsRent"},"example":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]}},"example":{"pay_now":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"rent":[{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1}]}},"OfferStatsPayNow":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/MoneyAmount"},"total_assets":{"type":"integer","description":"amount of assets bought with pay_now","example":1,"format":"int64"},"total_lines":{"type":"integer","description":"amount of offer line items with selected pay_now","example":1,"format":"int64"}},"example":{"amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"required":["amount","total_lines","total_assets"]},"OfferStatsRent":{"type":"object","properties":{"duration":{"type":"integer","description":"The duration in months","example":6,"enum":[0,6,12,24,30,36,48],"format":"int64"},"durations":{"type":"array","items":{"type":"integer","example":12,"enum":[6,12,24,30,36,48],"format":"int64"},"description":"The durations in months","example":[12]},"monthly_amount":{"$ref":"#/components/schemas/MoneyAmount"},"total_assets":{"type":"integer","description":"amount of assets bought with this duration","example":1,"format":"int64"},"total_lines":{"type":"integer","description":"amount of offer line items leased with this duration","example":1,"format":"int64"}},"example":{"duration":6,"durations":[12],"monthly_amount":{"currency":"EUR","gross":119000,"net":100000},"total_assets":1,"total_lines":1},"required":["monthly_amount","duration","durations","total_lines","total_assets"]},"OfferSummary":{"type":"object","properties":{"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerInfo"},"expires_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"}},"example":{"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"},"company_registration_number":"123456789","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"},"expires_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","shipping_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","recipient_name":"abc123","region":"abc123"}},"required":["expires_at","seller_offer_reference","id","created_at"]},"OfferSummaryForOps":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/SalesAgent"},"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerInfo"},"declined_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"expires_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"offer_confirmed_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"order_info":{"$ref":"#/components/schemas/OrderInfo"},"phone_number":{"type":"string","description":"Phone number","example":"abc123"},"sales_channel":{"type":"string","example":"ecommerce","enum":["telesales","ecommerce"]},"seller_info":{"$ref":"#/components/schemas/SellerInfo"},"seller_offer_reference":{"type":"string","description":"Partner's own reference for this offer","example":"abc123"},"set_to_pending_review_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"source":{"type":"string","description":"Source","example":"abc123"},"status":{"type":"string","example":"voided","enum":["created","voided","accepted","expired","rejected","pending_review","declined"]},"total_assets":{"type":"integer","description":"amount of assets in the offer: sum(lines.quantity)","example":1,"format":"int64"},"total_value":{"$ref":"#/components/schemas/MoneyAmount"},"user":{"$ref":"#/components/schemas/UserSummary"}},"example":{"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"},"company_registration_number":"123456789","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"}},"required":["id","customer","seller_info","created_at","status","total_assets","total_value","shipping_address","sales_channel","expires_at","seller_offer_reference"]},"OpsCatalogCreateImportResult":{"type":"object","properties":{"id":{"type":"string","description":"The import job ID.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"upload_url":{"type":"string","description":"The upload url in the storage where the uploaded CSV is located.","example":"https://example.com/foo","format":"uri"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","upload_url":"https://example.com/foo"},"required":["id","upload_url"]},"OpsCatalogImportCategorization":{"type":"object","properties":{"done":{"type":"boolean","description":"True once total \u003e 0 and pending == 0.","example":false},"pending":{"type":"integer","description":"Products still in to_be_categorized.","example":1,"format":"int64"},"supported":{"type":"integer","description":"Products successfully categorised.","example":1,"format":"int64"},"to_be_reviewed":{"type":"integer","description":"Products where the categoriser was uncertain.","example":1,"format":"int64"},"total":{"type":"integer","description":"Total products linked to this import.","example":1,"format":"int64"},"unsupported":{"type":"integer","description":"Products explicitly marked unsupported by the categoriser.","example":1,"format":"int64"}},"example":{"done":false,"pending":1,"supported":1,"to_be_reviewed":1,"total":1,"unsupported":1},"required":["total","pending","supported","to_be_reviewed","unsupported","done"]},"OpsCatalogImportJob":{"type":"object","properties":{"categorization":{"$ref":"#/components/schemas/OpsCatalogImportCategorization"},"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"error":{"type":"string","description":"Human-readable reason the import failed, populated when status is 'failed' before row processing starts.","example":"abc123"},"errors_url":{"type":"string","example":"https://example.com/foo","format":"uri"},"failed":{"type":"integer","description":"Number of rows that failed to import.","example":1,"format":"int64"},"filename":{"type":"string","description":"The original filename of the uploaded CSV.","example":"abc123"},"id":{"type":"string","description":"The import job ID.","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"object_path":{"type":"string","example":"https://example.com/foo","format":"uri"},"processed":{"type":"integer","description":"Total number of rows processed so far.","example":1,"format":"int64"},"status":{"type":"string","example":"queued","enum":["pending","queued","running","ingested","completed","failed","cancelled"]},"succeeded":{"type":"integer","description":"Number of rows successfully imported.","example":1,"format":"int64"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"categorization":{"done":false,"pending":1,"supported":1,"to_be_reviewed":1,"total":1,"unsupported":1},"created_at":"1970-01-01T00:00:01Z","error":"abc123","errors_url":"https://example.com/foo","failed":1,"filename":"abc123","id":"739b63c2-9e58-4964-b38d-4ebb424de242","object_path":"https://example.com/foo","processed":1,"status":"queued","succeeded":1,"updated_at":"1970-01-01T00:00:01Z"},"required":["id","status","filename","object_path","processed","succeeded","failed","created_at","updated_at"]},"OpsCreateImportRequestBody":{"type":"object","properties":{"filename":{"type":"string","description":"The name of the CSV file to import","example":"abc123"}},"example":{"filename":"abc123"}},"OpsSellerInfo":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"can_provide_serial_numbers":{"type":"boolean","description":"If the seller can provide serial number for assets","example":false},"can_use_parent_catalog":{"type":"boolean","description":"Allow the seller to use the parent catalog?","example":false},"capability_add_custom_products":{"type":"boolean","description":"If the seller can add custom products","example":false},"capability_anonymized_pricing":{"type":"boolean","description":"If the seller wishes to anonymize catalog prices","example":false},"capability_anonymous_ecom_offer_creation":{"type":"boolean","description":"Ability to skip required shipping address for ecom offers.","example":false},"capability_bundles":{"type":"boolean","description":"If the seller has bundles enabled","example":false},"capability_chatbot_id":{"type":"string","description":"Chatbot id for the seller. This enables a chatbase chatbot for the seller","example":"abc123"},"capability_dual_pricing":{"type":"boolean","description":"If true, the seller has the Dual Pricing system enabled","example":false},"capability_email_end_customer_on_offer_created":{"type":"boolean","description":"Ability to email the end customers when offers are created","example":false},"capability_hide_buy_now":{"type":"boolean","description":"If the seller should hide purchase only as option.","example":false},"capability_international_shipment":{"type":"boolean","description":"If the seller has international shipment enabled","example":false},"capability_show_ecom_orders":{"type":"boolean","description":"Show ecommerce orders to all telesales","example":false},"cc_ecommerce_is_active":{"type":"boolean","description":"If we should send notifications to the seller's CC email addresses when the channel is ecommerce","example":false},"cc_offer_accepted":{"type":"string","description":"The email addresses to send notifications when an offer is accepted separated by comma","example":"abc123"},"cc_offer_created":{"type":"string","description":"The email addresses to send notifications when an offer is created separated by comma","example":"abc123"},"cc_offer_declined":{"type":"string","description":"The email addresses to send notifications when an offer is declined separated by comma","example":"abc123"},"cc_telesales_is_active":{"type":"boolean","description":"If we should send notifications to the seller's CC email addresses when the channel is telesales","example":false},"central_catalog":{"type":"boolean","description":"Capability that marks if central catalog is enabled","example":false},"currency":{"type":"string","description":"The currency of the seller","example":"abc123"},"email":{"type":"string","description":"The seller email","example":"abc123"},"erp_integrated":{"type":"boolean","description":"If the seller is ERP integrated","example":false},"external_contractual_entity":{"$ref":"#/components/schemas/SellerExternalContractualEntity"},"id":{"type":"string","description":"The seller id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"kickback_ratio":{"type":"number","description":"The kickback ratio for the seller","example":1,"format":"double"},"logo_url":{"type":"string","description":"The seller logo","example":"abc123"},"name":{"type":"string","description":"The name of the seller","example":"abc123"},"parent_seller_id":{"type":"string","description":"the ID of the parent seller, we use this for multipliers","example":"abc123"},"pdf_reader_assistant_id":{"type":"string","description":"The assistant ID to use for PDF reader, use null to disable PDF reader","example":"abc123"},"pretty_name":{"type":"string","description":"The pretty, customer-facing name of the seller","example":"abc123"},"product_reference_source":{"type":"string","description":"The seller product reference source","example":"abc123"},"widget_id":{"type":"string","example":"abc123"}},"example":{"address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"can_provide_serial_numbers":false,"can_use_parent_catalog":false,"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_email_end_customer_on_offer_created":false,"capability_hide_buy_now":false,"capability_international_shipment":false,"capability_show_ecom_orders":false,"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false,"central_catalog":false,"currency":"abc123","email":"abc123","erp_integrated":false,"external_contractual_entity":{"contractual_entity":"abc123","external_id":"abc123","id":"abc123","risk_status":"approved","status_changed_at":"1970-01-01T00:00:01Z"},"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kickback_ratio":1,"logo_url":"abc123","name":"abc123","parent_seller_id":"abc123","pdf_reader_assistant_id":"abc123","pretty_name":"abc123","product_reference_source":"abc123","widget_id":"abc123"},"required":["central_catalog","erp_integrated","can_provide_serial_numbers","capability_dual_pricing","capability_hide_buy_now","capability_anonymized_pricing","capability_bundles","capability_show_ecom_orders","capability_email_end_customer_on_offer_created","capability_anonymous_ecom_offer_creation","capability_international_shipment","capability_add_custom_products","id","name","address","email","product_reference_source","currency"]},"OrderInfo":{"type":"object","properties":{"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"id":{"type":"string","description":"Order ID in Topi system","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"status":{"type":"string","example":"confirmed","enum":["created","confirmed","acknowledged","accepted","partially_fulfilled","completed","canceled","rejected"]}},"example":{"created_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","status":"confirmed"},"required":["id","status","created_at"]},"OrderResult":{"type":"object","properties":{"assets":{"type":"array","items":{"$ref":"#/components/schemas/Asset"},"description":"A list of assets in an offer","example":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}]},"id":{"type":"string","description":"topi order ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"metadata":{"type":"object","description":"Metadata you can attach to and order. You can store here any JSON information","example":{"tracking_number":"123456"},"additionalProperties":{"type":"string","example":"aaa","maxLength":400}},"offer_id":{"type":"string","description":"Reference to the topi offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_offer_reference":{"type":"string","description":"Seller’s own reference for this order","example":"abc123"},"status":{"type":"string","example":"confirmed","enum":["created","confirmed","acknowledged","accepted","partially_fulfilled","completed","canceled","rejected"]}},"description":"Basic information about an order","example":{"assets":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","metadata":{"tracking_number":"123456"},"offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","status":"confirmed"},"required":["id","offer_id","seller_offer_reference","status","assets"]},"OrdersListResult":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/OrderResult"},"description":"an array with the orders requested","example":[{"assets":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","metadata":{"tracking_number":"123456"},"offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","status":"confirmed"}]}},"example":{"orders":[{"assets":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","metadata":{"tracking_number":"123456"},"offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_offer_reference":"abc123","status":"confirmed"}]}},"Organization":{"type":"object","properties":{"id":{"type":"string","description":"id of the organization","example":"abc123"},"metadata":{"type":"object","description":"organization metadata","example":{"abc123":"abc123"},"additionalProperties":true},"name":{"type":"string","description":"organization name","example":"abc123"}},"example":{"id":"abc123","metadata":{"abc123":"abc123"},"name":"abc123"},"required":["id","name"]},"OrganizationMember":{"type":"object","properties":{"email":{"type":"string","description":"email of the user","example":"abc123"},"id":{"type":"string","description":"id of the user part of the organization","example":"abc123"},"name":{"type":"string","description":"name of the user","example":"abc123"}},"example":{"email":"abc123","id":"abc123","name":"abc123"},"required":["id","name","email"]},"OrganizationMembers":{"type":"object","properties":{"organizationMembers":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationMember"},"description":"list of all users linked to organization","example":[{"email":"abc123","id":"abc123","name":"abc123"}]}},"example":{"organizationMembers":[{"email":"abc123","id":"abc123","name":"abc123"}]},"required":["organizationMembers"]},"Organizations":{"type":"object","properties":{"organizations":{"type":"array","items":{"$ref":"#/components/schemas/Organization"},"description":"list of organizations","example":[{"id":"abc123","metadata":{"abc123":"abc123"},"name":"abc123"}]}},"example":{"organizations":[{"id":"abc123","metadata":{"abc123":"abc123"},"name":"abc123"}]},"required":["organizations"]},"OtpConfirmationResponse":{"type":"object","properties":{"anonymized_email":{"type":"string","example":"abc123"},"code":{"type":"string","description":"only for local development testing purposes","example":"abc123"}},"example":{"anonymized_email":"abc123","code":"abc123"},"required":["anonymized_email"]},"OverwriteAssetIDsPayload":{"type":"object","properties":{"assets":{"type":"array","items":{"$ref":"#/components/schemas/AssetIDs"},"description":"The list of asset IDs we want to update","example":[{"current_id":"739b63c2-9e58-4964-b38d-4ebb424de242","new_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}},"example":{"assets":[{"current_id":"739b63c2-9e58-4964-b38d-4ebb424de242","new_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]},"required":["assets"]},"OverwriteAssetIDsResult":{"type":"object","properties":{"unprocessed_ids":{"type":"array","items":{"type":"string","example":"abc123"},"description":"The list of asset IDs that were not updated","example":["abc123"]},"updated_assets":{"type":"array","items":{"$ref":"#/components/schemas/Asset"},"description":"The list of assets that were updated","example":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}]}},"example":{"unprocessed_ids":["abc123"],"updated_assets":[{"belongs_to_asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requires_serial_number":false,"seller_product_references":[{"reference":"123ab-5343","source":"sap"}],"serial_number":"BA-3456786-334-9","status":"shipped","title":"Pro Laptop 64GB","tracking_url":"abc123"}]},"required":["updated_assets","unprocessed_ids"]},"PageMetadata":{"type":"object","properties":{"has_more":{"type":"boolean","description":"Whether there are more pages","default":false,"example":false},"page":{"type":"integer","description":"Current page number (zero-indexed)","default":0,"example":0,"format":"int64"}},"description":"Metadata about the returned page","example":{"has_more":false,"page":0},"required":["page","has_more"]},"PagePayload":{"type":"object","properties":{"page":{"type":"integer","description":"Which page number to fetch (zero-indexed)","default":0,"example":0,"format":"int64"}},"example":{"page":0}},"PaginatedOfferSummaryForOps":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OfferSummaryForOps"},"description":"Array of OfferSummaryForOps","example":[{"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"},"company_registration_number":"123456789","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"}}]},"pagination":{"$ref":"#/components/schemas/CursorPageMetadata"}},"example":{"data":[{"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"},"company_registration_number":"123456789","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"}}],"pagination":{"has_more":false}},"required":["data","pagination"]},"PaginatedProduct":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"description":"Array of Product","example":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}]},"pagination":{"$ref":"#/components/schemas/CursorPageMetadata"}},"example":{"data":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}],"pagination":{"has_more":false}},"required":["data","pagination"]},"PaginatedShippingMethodOpsResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ShippingMethodOpsResult"},"description":"Array of ShippingMethodOpsResult","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","is_in_store_pickup":false,"name":"abc123","review_status":"to_be_reviewed","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_shipping_method_reference":"Sandbox Shipping Service"}]},"pagination":{"$ref":"#/components/schemas/PageMetadata"}},"example":{"data":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","is_in_store_pickup":false,"name":"abc123","review_status":"to_be_reviewed","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_shipping_method_reference":"Sandbox Shipping Service"}],"pagination":{"has_more":false,"page":0}},"required":["data","pagination"]},"Pagination":{"type":"object","properties":{"limit":{"type":"integer","description":"the size of the page, capped at 100","example":20,"format":"int64"},"page":{"type":"integer","description":"the index of the page, zero-based","example":0,"format":"int64"}},"example":{"limit":20,"page":0}},"PaginationMetadata":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number","example":1,"format":"int64"},"page_size":{"type":"integer","description":"Number of items per page","example":1,"format":"int64"},"total_count":{"type":"integer","description":"Total number of items","example":1,"format":"int64"},"total_pages":{"type":"integer","description":"Total number of pages","example":1,"format":"int64"}},"example":{"page":1,"page_size":1,"total_count":1,"total_pages":1}},"PaginationResult":{"type":"object","properties":{"limit":{"type":"integer","description":"the size of the page","example":1,"format":"int64"},"page":{"type":"integer","description":"the index of the page","example":1,"format":"int64"},"totalPages":{"type":"integer","description":"Total amount of pages available","example":1,"format":"int64"},"totalRows":{"type":"integer","description":"The total amount of rows","example":1,"format":"int64"}},"example":{"limit":1,"page":1,"totalPages":1,"totalRows":1}},"PayNow":{"type":"object","properties":{"pay_now_amount":{"$ref":"#/components/schemas/MoneyAmount"}},"example":{"pay_now_amount":{"currency":"EUR","gross":119000,"net":100000}},"required":["pay_now_amount"]},"PayNowContractTerm":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/MoneyAmount"},"id":{"type":"string","description":"The internal Id for the contract term","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"amount":{"currency":"EUR","gross":119000,"net":100000},"id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["amount"]},"PaymentMethod":{"type":"object","properties":{"account_holder_name":{"type":"string","description":"Name of the account holder, as known by the bank","example":"abc123"},"account_number_ending":{"type":"string","description":"The last few digits of the account number. 2 digits for most currencies","example":"abc123"},"bank_name":{"type":"string","description":"Name of the bank holding the account","example":"abc123"},"country_code":{"type":"string","description":"Country where the bank account is. ISO 3166-1 alpha-2 code","example":"abc123"},"provider":{"type":"string","example":"stripe_asset_gmbh","enum":["stripe","stripe_asset_gmbh"]},"type":{"type":"string","description":"Payment method type. Can be 'SEPA' or 'BACS'","example":"abc123"}},"example":{"account_holder_name":"abc123","account_number_ending":"abc123","bank_name":"abc123","country_code":"abc123","provider":"stripe_asset_gmbh","type":"abc123"},"required":["account_holder_name","account_number_ending","bank_name","country_code","type"]},"PhoneNumber":{"type":"object","properties":{"country_code":{"type":"string","description":"Country code","example":"abc123"},"country_prefix":{"type":"string","description":"Country code prefix","example":"abc123"},"international_format":{"type":"string","description":"International phone number format","example":"abc123"},"national":{"type":"string","description":"National phone number","example":"abc123"},"number":{"type":"string","description":"E164 number","example":"abc123"}},"example":{"country_code":"abc123","country_prefix":"abc123","international_format":"abc123","national":"abc123","number":"abc123"},"required":["number","country_prefix","country_code","national","international_format"]},"PolicyStep":{"type":"object","properties":{"id":{"type":"string","description":"Reminder Step ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"interval_days":{"type":"integer","description":"Number of days until reminder is triggered","example":1,"format":"int64"},"is_recurring":{"type":"boolean","description":"If step is recurring","example":false},"step_number":{"type":"integer","description":"Step number","example":1,"format":"int64"},"step_type":{"type":"string","description":"Reminder type","example":"abc123"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","interval_days":1,"is_recurring":false,"step_number":1,"step_type":"abc123"},"required":["id","step_type","step_number","interval_days","is_recurring"]},"PortalBulkSummary":{"type":"object","properties":{"count_new_agents":{"type":"integer","description":"Number of new agents added","example":1,"format":"int64"},"failed_agents":{"type":"array","items":{"type":"string","example":"abc123"},"description":"List of agents that failed to be added","example":["abc123"]}},"example":{"count_new_agents":1,"failed_agents":["abc123"]},"required":["count_new_agents"]},"PortalSalesAgent":{"type":"object","properties":{"email":{"type":"string","description":"E-mail","example":"alice@example.com","format":"email"},"external_agent_id":{"type":"string","description":"Id number used to identify the sales agent in the seller's internal system","example":"abc123"},"id":{"type":"string","description":"Auth0 Sales Agent ID","example":"auth0|63881a171828b3997ad1b3fc"},"language":{"type":"string","description":"User language","example":"abc123"},"last_login":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"name":{"type":"string","description":"Name of the agent","example":"abc123"},"phone":{"type":"string","description":"Phone number","example":"abc123"},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_store_id":{"type":"string","description":"Id number used to identify the store a PoS agent is operating from","example":"abc123"},"status":{"type":"string","description":"User status","example":"abc123"},"topi_relevant":{"type":"boolean","description":"Whether the user is relevant for driving topi GMV, this allows us to opt out users that are managers or are not expected to do much sales from reporting.","example":false}},"example":{"email":"alice@example.com","external_agent_id":"abc123","id":"auth0|63881a171828b3997ad1b3fc","language":"abc123","last_login":"1970-01-01T00:00:01Z","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123","status":"abc123","topi_relevant":false},"required":["id","name","phone","email"]},"PortalSalesAgents":{"type":"object","properties":{"agents":{"type":"array","items":{"$ref":"#/components/schemas/PortalSalesAgent"},"description":"List of Sales Agents","example":[{"email":"alice@example.com","external_agent_id":"abc123","id":"auth0|63881a171828b3997ad1b3fc","language":"abc123","last_login":"1970-01-01T00:00:01Z","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123","status":"abc123","topi_relevant":false}]}},"example":{"agents":[{"email":"alice@example.com","external_agent_id":"abc123","id":"auth0|63881a171828b3997ad1b3fc","language":"abc123","last_login":"1970-01-01T00:00:01Z","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123","status":"abc123","topi_relevant":false}]},"required":["agents"]},"PricingCategory":{"type":"object","properties":{"description":{"type":"string","description":"description of the pricing category","example":"abc123"},"headrooms":{"type":"array","items":{"$ref":"#/components/schemas/Headroom"},"description":"the headrooms for the pricing category","example":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}]},"id":{"type":"string","description":"topi pricing category ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"identifier":{"type":"string","description":"name of the pricing category","example":"abc123"},"services":{"type":"array","items":{"$ref":"#/components/schemas/PricingCategoryService"},"description":"the services for the pricing category","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}]}},"example":{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","identifier":"abc123","services":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}]},"required":["identifier","headrooms","services","id"]},"PricingCategoryIDPayload":{"type":"object","properties":{"id":{"type":"string","description":"Pricing Category ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["id"]},"PricingCategoryInfo":{"type":"object","properties":{"asset_id_prefix":{"type":"string","description":"description of the pricing category","example":"abc123"},"asset_reference":{"type":"string","description":"the headrooms for the pricing category","example":"abc123"},"asset_title":{"type":"string","description":"the services for the pricing category","example":"abc123"},"replace_title":{"type":"boolean","description":"should replace the title","example":false},"service_type":{"type":"string","description":"name of the pricing category","example":"abc123"}},"example":{"asset_id_prefix":"abc123","asset_reference":"abc123","asset_title":"abc123","replace_title":false,"service_type":"abc123"},"required":["service_type","asset_id_prefix","asset_reference","asset_title","replace_title"]},"PricingCategoryInfoResult":{"type":"object","properties":{"pricing_categories":{"type":"array","items":{"$ref":"#/components/schemas/PricingCategoryInfo"},"example":[{"asset_id_prefix":"abc123","asset_reference":"abc123","asset_title":"abc123","replace_title":false,"service_type":"abc123"}]}},"example":{"pricing_categories":[{"asset_id_prefix":"abc123","asset_reference":"abc123","asset_title":"abc123","replace_title":false,"service_type":"abc123"}]}},"PricingCategoryListResult":{"type":"object","properties":{"pricing_categories":{"type":"array","items":{"$ref":"#/components/schemas/PricingCategory"},"example":[{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","identifier":"abc123","services":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}]}]}},"example":{"pricing_categories":[{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","identifier":"abc123","services":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}]}]}},"PricingCategoryResult":{"type":"object","properties":{"pricing_category":{"$ref":"#/components/schemas/PricingCategory"}},"example":{"pricing_category":{"description":"abc123","headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","identifier":"abc123","services":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}]}}},"PricingCategoryService":{"type":"object","properties":{"id":{"type":"string","description":"topi service ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"name":{"type":"string","description":"name of the service","example":"abc123"},"service_prices":{"type":"array","items":{"$ref":"#/components/schemas/PricingCategoryServicePrice"},"description":"the prices for the service per tenure","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","name":"abc123","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1}]},"required":["id","name","service_prices"]},"PricingCategoryServicePrice":{"type":"object","properties":{"id":{"type":"string","description":"topi servicePrice ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"kind":{"type":"string","description":"the price of the service price","example":"abc123"},"price":{"type":"number","description":"price of the service for this tenure","example":1,"format":"double"},"tenure":{"type":"integer","description":"the tenure for this price","example":1,"format":"int64"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kind":"abc123","price":1,"tenure":1},"required":["id","kind","tenure"]},"PricingInputInformation":{"type":"object","properties":{"headroom_info":{"type":"array","items":{"$ref":"#/components/schemas/Headroom"},"example":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}]},"pricing_category":{"type":"string","description":"Pricing category of the product","example":"abc123"},"pricing_category_confidence":{"type":"integer","description":"Confidence that the assignment of the category is correct","example":1,"format":"int64"}},"example":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1}},"PricingOverview":{"type":"object","properties":{"instead_of_amount":{"$ref":"#/components/schemas/MoneyAmount"},"items_summaries":{"type":"array","items":{"$ref":"#/components/schemas/ItemSummary"},"description":"Price summary for each item: main line and sublines.","example":[{"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":{"$ref":"#/components/schemas/RentInfo"},"should_show_instead_of_amount":{"type":"boolean","description":"A boolean to decide when to show the instead of amount based on calculated values","example":false},"total_amount_first_payment":{"$ref":"#/components/schemas/MoneyAmount"},"total_amount_first_payment_without_shipping":{"$ref":"#/components/schemas/MoneyAmount"},"total_purchase_amount":{"$ref":"#/components/schemas/MoneyAmount"}},"example":{"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}},"required":["instead_of_amount","should_show_instead_of_amount","total_amount_first_payment","total_amount_first_payment_without_shipping","total_purchase_amount","rent_info"]},"Product":{"type":"object","properties":{"base_rental_price":{"$ref":"#/components/schemas/MoneyAmount"},"categorization_suggestions":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategorizationSuggestion"},"description":"Model categorization suggestions ordered by confidence descending","example":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}]},"description":{"type":"string","description":"Description of product","example":"aaa","maxLength":2000},"extra_details":{"type":"array","items":{"$ref":"#/components/schemas/ExtraProductDetails"},"description":"Extra details about the product such as CPU, Memory, storage...","example":[{"property":"memory","value":"16GB DDR5"}]},"id":{"type":"string","description":"topi Product ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"image":{"$ref":"#/components/schemas/ProductImage"},"is_active":{"type":"boolean","description":"If product is still active","example":false},"is_fully_reviewed":{"type":"boolean","description":"Whether this product has been marked as fully reviwed","example":false},"list_price":{"$ref":"#/components/schemas/MoneyAmount"},"manufacturer":{"type":"string","description":"The product manufacturer","example":"abc123"},"origin":{"type":"string","description":"origin of the product, 'manual' for topi tool, 'automatic' for catalog ingestion","example":"abc123"},"origin_seller":{"type":"string","description":"the seller origin for central catalog","example":"abc123"},"origin_seller_references":{"type":"array","items":{"$ref":"#/components/schemas/SellerProductReference"},"description":"the origin seller references for the central catalog","example":[{"reference":"123ab-5343","source":"sap"}]},"pretty_id":{"type":"string","description":"The visual overriding id of the product","example":"abc123"},"pricing_category":{"type":"string","description":"The pricing category that should be assigned","example":"iphone_17_pro","enum":["iphone_17","iphone_17_pro","iphone_17_pro_max","iphone_air","iphone_17_e","iphone_16_pro_max","iphone_16_pro","iphone_16_plus","iphone_16","iphone_15_pro_max","iphone_15_pro","iphone_15_plus","iphone_15","iphone_14_pro_max","iphone_14_pro","iphone_14_plus","iphone_14","iphone_13_pro_max","iphone_13_pro","iphone_13","iphone_12","iphone_11","iphone_se_22","iphone_se_20","macbook_pro_13_14","macbook_pro_13_14_m3","macbook_pro_13_14_m4","macbook_pro_13_14_m5","macbook_pro_15_16","macbook_pro_15_16_m3","macbook_pro_15_16_m4","macbook_pro_15_16_m5","macbook_air","macbook_air_13_m5","macbook_air_15_m5","macbook_neo","mac_desktop","mac_desktop_m4","mac_studio","mac_pro_m2","apple_display","studio_display_2026","studio_display_2022","studio_display_xdr","ipad_pro","ipad_pro_m5","ipad_pro_m4","ipad_pro_12_9_inch_7_gen","ipad_pro_12_9_inch_6_gen","ipad_pro_12_9_inch_5_gen","ipad_pro_11_inch_4_gen","ipad_air","ipad_air_m4","ipad_air_m3","ipad_air_6_gen","ipad_air_5_gen","ipad_air_4_gen","ipad_regular","ipad_regular_11_gen","ipad_regular_10_gen","ipad_regular_9_gen","ipad_mini","ipad_mini_6_gen","smartwatch_apple","smartwatch_apple_ultra","smartwatch_other","laptop_other_top","laptop_other_low","desktop_other_top","desktop_other_low","phone_other_top","phone_other_low","tablet_other_top","tablet_other_low","screen","accessory_other","accessory_airpods","accessory_pencil","accessory_homepod","accessory_visionpro","services_insurance","software","services_management","printer","iphone_16_e","server","network_security","mac_pro","mac_studio_m3","mac_studio_m4","accessory_smartfolio","accessory_appletv","accessory_gpu",""]},"pricing_category_confidence":{"type":"integer","description":"Optional confidence of the category classification","example":1,"format":"int64","minimum":0,"maximum":100},"pricing_input_information":{"$ref":"#/components/schemas/PricingInputInformation"},"product_standard_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/ProductStandardIdentifier"},"description":"Standard identifiers for this product","example":[{"id":"123ab-4567","identifier_type":"EAN"}]},"publicized_price":{"$ref":"#/components/schemas/MoneyAmount"},"review_status":{"type":"string","example":"unsupported","enum":["supported","unsupported","to_be_reviewed"]},"seller_categories":{"type":"array","items":{"$ref":"#/components/schemas/ProductSellerCategory"},"description":"Categories from the seller","example":[{"id":"abc123","name":"abc123","parent_category":"abc123"}]},"seller_product_references":{"type":"array","items":{"$ref":"#/components/schemas/SellerProductReference"},"description":"Partner's own reference for this product","example":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"minItems":1},"seller_product_type":{"type":"string","example":"software","enum":["hardware","software","service","hardware_built_to_order"]},"shop_product_description_url":{"type":"string","example":"https://example.com/foo","format":"uri"},"subtitle":{"type":"string","description":"Subtitle of product","example":"abc123"},"title":{"type":"string","description":"Name for product","example":"abc123"}},"example":{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"},"required":["id","review_status","is_fully_reviewed","pricing_input_information","title","seller_product_references","publicized_price","is_active"]},"ProductCategorizationSuggestion":{"type":"object","properties":{"category":{"type":"string","description":"Suggested pricing category","example":"abc123"},"confidence":{"type":"integer","description":"Confidence score (0-100)","example":1,"format":"int64"},"model_name":{"type":"string","description":"Name of the model that produced this suggestion","example":"abc123"},"model_version":{"type":"string","description":"Version of the model","example":"abc123"}},"example":{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"},"required":["category","confidence","model_name","model_version"]},"ProductIDList":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","example":"abc123","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"description":"List of IDs of topi products","example":["abc123"]}},"example":{"ids":["abc123"]},"required":["ids"]},"ProductImage":{"type":"object","properties":{"url":{"type":"string","description":"Url hosting the image","example":"https://example.com/foo","format":"uri"}},"example":{"url":"https://example.com/foo"}},"ProductSellerCategory":{"type":"object","properties":{"id":{"type":"string","example":"abc123"},"name":{"type":"string","example":"abc123"},"parent_category":{"type":"string","example":"abc123"}},"example":{"id":"abc123","name":"abc123","parent_category":"abc123"},"required":["name","id"]},"ProductStandardIdentifier":{"type":"object","properties":{"id":{"type":"string","description":"The product identifier value","example":"123ab-4567"},"identifier_type":{"type":"string","description":"The kind of identifier standard","example":"EAN"}},"example":{"id":"123ab-4567","identifier_type":"EAN"}},"ProductSuggestion":{"type":"object","properties":{"product_id":{"type":"string","description":"topi Product ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_id":{"type":"string","description":"The id of the seller","example":"abc123"},"subtitle":{"type":"string","description":"The subtitle of the product","example":"abc123"},"suggestion_weight":{"type":"integer","description":"The weight of the suggestion","example":1,"format":"int64"},"title":{"type":"string","description":"The title of the product","example":"abc123"}},"example":{"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"abc123","subtitle":"abc123","suggestion_weight":1,"title":"abc123"}},"ProductSuggestionPayload":{"type":"object","properties":{"product_id":{"type":"string","description":"The id of the product","example":"abc123"},"seller_id":{"type":"string","description":"The id of the seller","example":"abc123"},"suggestion_weight":{"type":"integer","description":"The weight of the suggestion","example":1,"format":"int64"}},"example":{"product_id":"abc123","seller_id":"abc123","suggestion_weight":1},"required":["product_id","suggestion_weight","seller_id"]},"PubSubPayload":{"type":"object","properties":{"authToken":{"type":"string","description":"JWT token used to perform authorization","example":"abc123"},"deliveryAttempt":{"type":"integer","description":"The number of times the service has attempted to deliver a message.","example":1,"format":"int64"},"message":{"$ref":"#/components/schemas/MessagePayload"},"subscription":{"type":"string","description":"The subscription name.","example":"abc123"},"verificationToken":{"type":"string","description":"Verification token sent as a query string","example":"abc123"}},"description":"data sent when the request is initiated by Google","example":{"authToken":"abc123","deliveryAttempt":1,"message":{"attributes":{"abc123":"abc123"},"data":"abc123","messageId":"abc123","orderingKey":"abc123","publishTime":"abc123"},"subscription":"abc123","verificationToken":"abc123"},"required":["verificationToken"]},"PubSubPayload2":{"type":"object","properties":{"deliveryAttempt":{"type":"integer","description":"The number of times the service has attempted to deliver a message.","example":1,"format":"int64"},"message":{"$ref":"#/components/schemas/MessagePayload"},"subscription":{"type":"string","description":"The subscription name.","example":"abc123"}},"example":{"deliveryAttempt":1,"message":{"attributes":{"abc123":"abc123"},"data":"abc123","messageId":"abc123","orderingKey":"abc123","publishTime":"abc123"},"subscription":"abc123"}},"PubSubPayload3":{"type":"object","properties":{"deliveryAttempt":{"type":"integer","description":"The number of times the service has attempted to deliver a message.","example":1,"format":"int64"},"message":{"$ref":"#/components/schemas/MessagePayload"},"subscription":{"type":"string","description":"The subscription name.","example":"abc123"}},"example":{"deliveryAttempt":1,"message":{"attributes":{"abc123":"abc123"},"data":"abc123","messageId":"abc123","orderingKey":"abc123","publishTime":"abc123"},"subscription":"abc123"}},"PubSubPayload4":{"type":"object","properties":{"deliveryAttempt":{"type":"integer","description":"The number of times the service has attempted to deliver a message.","example":1,"format":"int64"},"message":{"$ref":"#/components/schemas/MessagePayload"},"subscription":{"type":"string","description":"The subscription name.","example":"abc123"}},"example":{"deliveryAttempt":1,"message":{"attributes":{"abc123":"abc123"},"data":"abc123","messageId":"abc123","orderingKey":"abc123","publishTime":"abc123"},"subscription":"abc123"}},"Reference":{"type":"object","properties":{"reference":{"type":"string","description":"The ID related with the source. This value should be unique for that source.","example":"123ab-5343","pattern":"[a-zA-Z0-9._-]","minLength":1}},"example":{"reference":"123ab-5343"}},"Reminder":{"type":"object","properties":{"current_step_id":{"type":"string","description":"Current step id","example":"abc123"},"id":{"type":"string","description":"The reminder ID","example":"abc123"},"last_run_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"next_run_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"reminder_type":{"type":"string","description":"Reminder type","example":"abc123"},"run_count":{"type":"integer","description":"Run count","example":1,"format":"int64"},"user_id":{"type":"string","description":"User ID","example":"abc123"}},"example":{"current_step_id":"abc123","id":"abc123","last_run_at":"1970-01-01T00:00:01Z","next_run_at":"1970-01-01T00:00:01Z","reminder_type":"abc123","run_count":1,"user_id":"abc123"},"required":["id","reminder_type","user_id","run_count","current_step_id"]},"Reminders":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/Reminder"},"description":"the active reminders","example":[{"current_step_id":"abc123","id":"abc123","last_run_at":"1970-01-01T00:00:01Z","next_run_at":"1970-01-01T00:00:01Z","reminder_type":"abc123","run_count":1,"user_id":"abc123"}]}},"example":{"values":[{"current_step_id":"abc123","id":"abc123","last_run_at":"1970-01-01T00:00:01Z","next_run_at":"1970-01-01T00:00:01Z","reminder_type":"abc123","run_count":1,"user_id":"abc123"}]}},"RemoveOpsRequestBody":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","example":"abc123"},"description":"Emails to remove from the allowlist","example":["abc123"]}},"example":{"emails":["abc123"]},"required":["emails"]},"RemoveSellerPayload":{"type":"object","properties":{"id":{"type":"string","example":"abc123"},"name":{"type":"string","description":"The name of the seller","example":"abc123"}},"example":{"id":"abc123","name":"abc123"},"required":["name","id"]},"Rent":{"type":"object","properties":{"duration":{"type":"integer","description":"Duration of the rental term in months.","example":12,"enum":[6,12,24,36],"format":"int64"},"monthly_amount":{"$ref":"#/components/schemas/MoneyAmount"}},"example":{"duration":12,"monthly_amount":{"currency":"EUR","gross":119000,"net":100000}},"required":["monthly_amount","duration"]},"RentContractTerm":{"type":"object","properties":{"duration":{"type":"integer","description":"The duration in months","example":6,"enum":[0,6,12,24,30,36,48],"format":"int64"},"id":{"type":"string","description":"The internal Id for the contract term","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"monthly_amount":{"$ref":"#/components/schemas/MoneyAmount"}},"example":{"duration":6,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}},"required":["monthly_amount","duration"]},"RentContractTermResult":{"type":"object","properties":{"duration":{"type":"integer","description":"The duration in months","example":6,"enum":[0,6,12,24,30,36,48],"format":"int64"},"durations":{"type":"array","items":{"type":"integer","example":12,"enum":[6,12,24,30,36,48],"format":"int64"},"description":"The durations in months","example":[12]},"id":{"type":"string","description":"The internal Id for the contract term","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"monthly_amount":{"$ref":"#/components/schemas/MoneyAmount"}},"example":{"duration":6,"durations":[12],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","monthly_amount":{"currency":"EUR","gross":119000,"net":100000}},"required":["durations","monthly_amount","duration"]},"RentInfo":{"type":"object","properties":{"rent_only_amount":{"$ref":"#/components/schemas/MoneyAmount"},"tenure_lines":{"type":"array","items":{"$ref":"#/components/schemas/TenureLine"},"description":"Different lines with the different items that are important for the payment.","example":[{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6}]},"total_rent":{"$ref":"#/components/schemas/MoneyAmount"}},"example":{"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}},"required":["total_rent","rent_only_amount","tenure_lines"]},"RentTenure":{"type":"object","properties":{"duration":{"type":"integer","description":"The duration in months","example":6,"enum":[0,6,12,24,30,36,48],"format":"int64"}},"example":{"duration":6}},"RentTenures":{"type":"object","properties":{"durations":{"type":"array","items":{"type":"integer","example":12,"enum":[6,12,24,30,36,48],"format":"int64"},"description":"The durations in months","example":[12]}},"example":{"durations":[12]}},"ResendOtpPayload":{"type":"object","properties":{"offer_share_token":{"type":"string","description":"The shared token from an offer","example":"abc123"}},"description":"Payload to resend OTP code","example":{"offer_share_token":"abc123"},"required":["offer_share_token"]},"ResetCategorizedProductsResponseBody":{"type":"object","properties":{"total":{"type":"integer","example":1,"format":"int64"}},"example":{"total":1}},"ReturnRequest":{"type":"object","properties":{"asset_id":{"type":"string","description":"ID of asset","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"company_name":{"type":"string","description":"Company name from end customer","example":"abc123"},"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"email":{"type":"string","description":"Email of the user","example":"abc123"},"end_customer_id":{"type":"string","description":"ID of end customer","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"requested_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"return_fee":{"$ref":"#/components/schemas/MoneyValue"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"user_id":{"type":"string","description":"ID of user","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","company_name":"abc123","created_at":"1970-01-01T00:00:01Z","email":"abc123","end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requested_at":"1970-01-01T00:00:01Z","return_fee":{"amount":34000,"currency":"EUR"},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["asset_id","user_id","end_customer_id","company_name","email","return_fee","requested_at","created_at","updated_at"]},"ReturnRequestsListResult":{"type":"object","properties":{"return_requests":{"type":"array","items":{"$ref":"#/components/schemas/ReturnRequest"},"description":"an array with the return requests","example":[{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","company_name":"abc123","created_at":"1970-01-01T00:00:01Z","email":"abc123","end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requested_at":"1970-01-01T00:00:01Z","return_fee":{"amount":34000,"currency":"EUR"},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}},"example":{"return_requests":[{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","company_name":"abc123","created_at":"1970-01-01T00:00:01Z","email":"abc123","end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","requested_at":"1970-01-01T00:00:01Z","return_fee":{"amount":34000,"currency":"EUR"},"updated_at":"1970-01-01T00:00:01Z","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}},"ReviewCatalogResult":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"description":"Products pending review","example":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}]},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"example":{"data":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}],"pagination":{"page":1,"page_size":1,"total_count":1,"total_pages":1}},"required":["data","pagination"]},"SalesAgent":{"type":"object","properties":{"email":{"type":"string","description":"E-mail","example":"alice@example.com","format":"email"},"external_agent_id":{"type":"string","description":"Id number used to identify the sales agent in the seller's internal system","example":"abc123"},"name":{"type":"string","description":"Name of the agent","example":"abc123"},"phone":{"type":"string","description":"Phone number","example":"abc123"}},"description":"Sales agent related to an offer","example":{"email":"alice@example.com","external_agent_id":"abc123","name":"abc123","phone":"abc123"},"required":["name","phone","email"]},"SellerAccess":{"type":"object","properties":{"seller_catalog_provider_id":{"type":"string","description":"The id of the seller whom the accessor can now access","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_id":{"type":"string","description":"The id of the seller who has been granted access","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"seller_catalog_provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["seller_id","seller_catalog_provider_id"]},"SellerAccessResult":{"type":"object","properties":{"id":{"type":"string","description":"topi ID for the customer","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_catalog_provider_id":{"type":"string","description":"The id of the seller whom the accessor can now access","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_id":{"type":"string","description":"The id of the seller who has been granted access","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_catalog_provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["seller_id","seller_catalog_provider_id"]},"SellerAccessResults":{"type":"object","properties":{"sellerAccesses":{"type":"array","items":{"$ref":"#/components/schemas/SellerAccessResult"},"example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_catalog_provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}},"example":{"sellerAccesses":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_catalog_provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]},"required":["sellerAccesses"]},"SellerExternalContractualEntity":{"type":"object","properties":{"contractual_entity":{"type":"string","description":"The external contractual entity name","example":"abc123"},"external_id":{"type":"string","description":"The external ID assigned by the contractual entity partner","example":"abc123"},"id":{"type":"string","description":"The ID of the seller contractual entity record","example":"abc123"},"risk_status":{"type":"string","description":"The risk assessment status","example":"approved","enum":["pending","approved","declined"]},"status_changed_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"contractual_entity":"abc123","external_id":"abc123","id":"abc123","risk_status":"approved","status_changed_at":"1970-01-01T00:00:01Z"},"required":["id","contractual_entity","risk_status"]},"SellerIDPayload":{"type":"object","properties":{"id":{"type":"string","description":"Seller Id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["id"]},"SellerInfo":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"capability_add_custom_products":{"type":"boolean","description":"If the seller can add custom products","example":false},"capability_anonymized_pricing":{"type":"boolean","description":"If the seller wishes to anonymize catalog prices","example":false},"capability_anonymous_ecom_offer_creation":{"type":"boolean","description":"Ability to skip required shipping address for ecom offers.","example":false},"capability_bundles":{"type":"boolean","description":"If the seller has bundles enabled","example":false},"capability_chatbot_id":{"type":"string","description":"Chatbot id for the seller. This enables a chatbase chatbot for the seller","example":"abc123"},"capability_dual_pricing":{"type":"boolean","description":"If true, the seller has the Dual Pricing system enabled","example":false},"capability_hide_buy_now":{"type":"boolean","description":"If the seller should hide purchase only as option.","example":false},"capability_international_shipment":{"type":"boolean","description":"If the seller has international shipment enabled","example":false},"currency":{"type":"string","description":"The currency of the seller","example":"abc123"},"email":{"type":"string","description":"The seller email","example":"abc123"},"id":{"type":"string","description":"The seller id","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"logo_url":{"type":"string","description":"The seller logo","example":"abc123"},"name":{"type":"string","description":"The name of the seller","example":"abc123"},"parent_seller_id":{"type":"string","description":"the ID of the parent seller, we use this for multipliers","example":"abc123"},"pdf_reader_assistant_id":{"type":"string","description":"The assistant ID to use for PDF reader, use null to disable PDF reader","example":"abc123"},"pretty_name":{"type":"string","description":"The pretty, customer-facing name of the seller","example":"abc123"},"product_reference_source":{"type":"string","description":"The seller product reference source","example":"abc123"}},"example":{"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"},"required":["id","name","address","email","product_reference_source","capability_dual_pricing","capability_hide_buy_now","capability_anonymized_pricing","capability_bundles","capability_anonymous_ecom_offer_creation","capability_international_shipment","capability_add_custom_products","currency"]},"SellerNotificationsCC":{"type":"object","properties":{"cc_ecommerce_is_active":{"type":"boolean","description":"If we should send notifications to the seller's CC email addresses when the channel is ecommerce","example":false},"cc_offer_accepted":{"type":"string","description":"The email addresses to send notifications when an offer is accepted separated by comma","example":"abc123"},"cc_offer_created":{"type":"string","description":"The email addresses to send notifications when an offer is created separated by comma","example":"abc123"},"cc_offer_declined":{"type":"string","description":"The email addresses to send notifications when an offer is declined separated by comma","example":"abc123"},"cc_telesales_is_active":{"type":"boolean","description":"If we should send notifications to the seller's CC email addresses when the channel is telesales","example":false}},"example":{"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false}},"SellerOAuthClient":{"type":"object","properties":{"client_id":{"type":"string","description":"OAuth client ID","example":"abc123"},"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"name":{"type":"string","description":"OAuth client name","example":"abc123"},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"updated_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"client_id":"abc123","created_at":"1970-01-01T00:00:01Z","name":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","updated_at":"1970-01-01T00:00:01Z"},"required":["seller_id","name","client_id","created_at","updated_at"]},"SellerOAuthClientCreate":{"type":"object","properties":{"client_id":{"type":"string","description":"OAuth client ID","example":"abc123"},"client_secret":{"type":"string","description":"OAuth client secret - ONLY returned on creation, store securely","example":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"},"name":{"type":"string","description":"OAuth client name","example":"abc123"},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"client_id":"abc123","client_secret":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6","name":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["seller_id","name","client_id","client_secret"]},"SellerOAuthClients":{"type":"object","properties":{"clients":{"type":"array","items":{"$ref":"#/components/schemas/SellerOAuthClient"},"description":"List of OAuth clients","example":[{"client_id":"abc123","created_at":"1970-01-01T00:00:01Z","name":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","updated_at":"1970-01-01T00:00:01Z"}]}},"example":{"clients":[{"client_id":"abc123","created_at":"1970-01-01T00:00:01Z","name":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","updated_at":"1970-01-01T00:00:01Z"}]},"required":["clients"]},"SellerPayload":{"type":"object","properties":{"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["seller_id"]},"SellerProductReference":{"type":"object","properties":{"reference":{"type":"string","description":"The ID related with the source. This value should be unique for that source.","example":"123ab-5343","pattern":"[a-zA-Z0-9._-]","minLength":1},"source":{"type":"string","description":"The seller internal source name for this reference type.","example":"sap","minLength":1}},"example":{"reference":"123ab-5343","source":"sap"},"required":["source","reference"]},"SellerWebhookUrls":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string","example":"https://example.com/foo","format":"uri"},"description":"The list of webhook urls registered for this seller","example":["https://example.com/foo"]}},"example":{"urls":["https://example.com/foo"]}},"SellerWidgetInfo":{"type":"object","properties":{"seller_id":{"type":"string","description":"Seller's own ID","example":"abc123"},"widget_id":{"type":"string","description":"Seller's widget ID","example":"abc123"}},"example":{"seller_id":"abc123","widget_id":"abc123"},"required":["seller_id","widget_id"]},"Sellers":{"type":"object","properties":{"sellers":{"type":"array","items":{"$ref":"#/components/schemas/OpsSellerInfo"},"description":"List of all available sellers","example":[{"address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"can_provide_serial_numbers":false,"can_use_parent_catalog":false,"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_email_end_customer_on_offer_created":false,"capability_hide_buy_now":false,"capability_international_shipment":false,"capability_show_ecom_orders":false,"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false,"central_catalog":false,"currency":"abc123","email":"abc123","erp_integrated":false,"external_contractual_entity":{"contractual_entity":"abc123","external_id":"abc123","id":"abc123","risk_status":"approved","status_changed_at":"1970-01-01T00:00:01Z"},"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kickback_ratio":1,"logo_url":"abc123","name":"abc123","parent_seller_id":"abc123","pdf_reader_assistant_id":"abc123","pretty_name":"abc123","product_reference_source":"abc123","widget_id":"abc123"}]}},"example":{"sellers":[{"address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"can_provide_serial_numbers":false,"can_use_parent_catalog":false,"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_email_end_customer_on_offer_created":false,"capability_hide_buy_now":false,"capability_international_shipment":false,"capability_show_ecom_orders":false,"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false,"central_catalog":false,"currency":"abc123","email":"abc123","erp_integrated":false,"external_contractual_entity":{"contractual_entity":"abc123","external_id":"abc123","id":"abc123","risk_status":"approved","status_changed_at":"1970-01-01T00:00:01Z"},"id":"739b63c2-9e58-4964-b38d-4ebb424de242","kickback_ratio":1,"logo_url":"abc123","name":"abc123","parent_seller_id":"abc123","pdf_reader_assistant_id":"abc123","pretty_name":"abc123","product_reference_source":"abc123","widget_id":"abc123"}]},"required":["sellers"]},"SendOpenBankingEmailOpsPayload":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["offer_id"]},"SendTestEmailRequestBody":{"type":"object","properties":{"email":{"type":"string","example":"abc123"},"seller_id":{"type":"string","example":"abc123"}},"example":{"email":"abc123","seller_id":"abc123"},"required":["email","seller_id"]},"SerialNumberByAsset":{"type":"object","properties":{"asset_id":{"type":"string","description":"The topi asset ID to update","example":"abc123"},"seller_product_reference":{"$ref":"#/components/schemas/SellerProductReference"},"serial_number":{"type":"string","description":"This is an id that identifies this asset as unique","example":"BA-3456786-334-9"},"tracking_url":{"type":"string","description":"The tracking URL of the product shipment","example":"abc123"}},"example":{"asset_id":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"},"serial_number":"BA-3456786-334-9","tracking_url":"abc123"},"required":["asset_id","serial_number"]},"ServicePriceUpdate":{"type":"object","properties":{"id":{"type":"string","description":"topi servicePrice ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"price":{"type":"number","description":"price of the service for this tenure","example":1,"format":"double"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","price":1},"required":["id"]},"ServicesSelectedByOfferLine":{"type":"object","properties":{"offer_line_id":{"type":"string","description":"The id of the offer line related","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"selected_services":{"type":"array","items":{"type":"string","example":"abc123"},"description":"The id(s) of the selected services","example":["abc123"]}},"example":{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_services":["abc123"]},"required":["offer_line_id"]},"ServicesSelectionPayload":{"type":"object","properties":{"offer_line_services":{"type":"array","items":{"$ref":"#/components/schemas/ServicesSelectedByOfferLine"},"example":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_services":["abc123"]}]}},"example":{"offer_line_services":[{"offer_line_id":"739b63c2-9e58-4964-b38d-4ebb424de242","selected_services":["abc123"]}]},"required":["offer_line_services"]},"SetEndCustomerIDPayload":{"type":"object","properties":{"end_customer_id":{"type":"string","description":"The end_customer_id that should be attached to the offer","example":"abc123"}},"description":"Payload for setting the end customer id of an offer","example":{"end_customer_id":"abc123"},"required":["end_customer_id"]},"SetIsActiveRequestBody":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","example":"abc123"},"description":"The ids of products","example":["abc123"]},"is_active":{"type":"boolean","example":false}},"example":{"ids":["abc123"],"is_active":false},"required":["ids","is_active"]},"SetUserIDPayload":{"type":"object","properties":{"user_id":{"type":"string","description":"The user_id that should be updated for the offer","example":"abc123"}},"description":"Payload for setting the user id of an offer","example":{"user_id":"abc123"},"required":["user_id"]},"SetupStripeCheckoutDataResponseBody":{"type":"object","properties":{"client_secret":{"type":"string","example":"abc123"},"session_id":{"type":"string","example":"abc123"}},"example":{"client_secret":"abc123","session_id":"abc123"},"required":["client_secret"]},"Shipment":{"type":"object","properties":{"seller_id":{"type":"string","description":"id of the seller owner of this order","example":"abc123"},"serial_numbers":{"type":"array","items":{"$ref":"#/components/schemas/SerialNumberByAsset"},"description":"The serial numbers to register","example":[{"asset_id":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"},"serial_number":"BA-3456786-334-9","tracking_url":"abc123"}]}},"example":{"seller_id":"abc123","serial_numbers":[{"asset_id":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"},"serial_number":"BA-3456786-334-9","tracking_url":"abc123"}]},"required":["serial_numbers","seller_id"]},"ShippingAddress":{"type":"object","properties":{"city":{"type":"string","description":"City","example":"abc123"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2","example":"DE"},"line1":{"type":"string","description":"First line (street, number, etc.)","example":"abc123"},"line2":{"type":"string","description":"Second line (flat number, etc.)","example":"aaa","maxLength":40},"postal_code":{"type":"string","description":"Postal code","example":"abc123"},"recipient_name":{"type":"string","description":"Full name of the recipient","example":"abc123"},"region":{"type":"string","description":"Region, county, province, etc.","example":"abc123"}},"example":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","recipient_name":"abc123","region":"abc123"},"required":["line1","postal_code","city","country_code"]},"ShippingAddressUpdate":{"type":"object","properties":{"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"}},"example":{"shipping_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","recipient_name":"abc123","region":"abc123"}},"required":["shipping_address"]},"ShippingInfo":{"type":"object","properties":{"is_in_store_pickup":{"type":"boolean","example":false},"price":{"$ref":"#/components/schemas/MoneyAmount"},"seller_shipping_reference":{"type":"string","description":"Seller's own reference for shipping method","example":"Sandbox Shipping Service"}},"description":"Shipping information","example":{"is_in_store_pickup":false,"price":{"currency":"EUR","gross":119000,"net":100000},"seller_shipping_reference":"Sandbox Shipping Service"},"required":["seller_shipping_reference","price"]},"ShippingMethodOpsResult":{"type":"object","properties":{"id":{"type":"string","description":"shipping method ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"is_in_store_pickup":{"type":"boolean","example":false},"name":{"type":"string","description":"Shipping method name","example":"abc123"},"review_status":{"type":"string","example":"unsupported","enum":["supported","unsupported","to_be_reviewed"]},"seller_id":{"type":"string","description":"seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_shipping_method_reference":{"type":"string","description":"Seller's own reference for this shipping method","example":"Sandbox Shipping Service"}},"description":"Basic information about a shipping method of a specific seller","example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","is_in_store_pickup":false,"name":"abc123","review_status":"to_be_reviewed","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_shipping_method_reference":"Sandbox Shipping Service"},"required":["id","seller_shipping_method_reference","review_status","name"]},"SignUpPayload":{"type":"object","properties":{"email":{"type":"string","description":"the email of the customer signing up, if we don't have an email connected to the offer already","example":"abc123"},"marketing_accepted":{"type":"boolean","description":"mark if the user has accepted to received marketing communications.","example":false},"offer_share_token":{"type":"string","description":"The shared token from an offer","example":"abc123"}},"description":"Payload for sign up with OTP","example":{"email":"abc123","marketing_accepted":false,"offer_share_token":"abc123"},"required":["offer_share_token","marketing_accepted"]},"StartOpsTradeInProcessPayload":{"type":"object","properties":{"asset_id":{"type":"string","description":"The asset ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"contract_start_date":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"override_address":{"$ref":"#/components/schemas/Address"},"trade_in_type":{"type":"string","description":"Trade in type, e.g. return_in_progress","example":"abc123"},"user_email":{"type":"string","description":"E-mail of the user that requested the trade-in process","example":"alice@example.com","format":"email"}},"example":{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","contract_start_date":"1970-01-01T00:00:01Z","override_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"trade_in_type":"abc123","user_email":"alice@example.com"},"required":["user_email","asset_id","trade_in_type","contract_start_date"]},"StripeSetupIntentPayload":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer ID associated with the checkout session","example":"abc123"},"stripe_checkout_session_return_url":{"type":"string","description":"The return URL at end of Stripe Checkout Session","example":"abc123"},"use_stripe_checkout_session":{"type":"boolean","description":"Use Stripe Checkout Session instead of Stripe SetupIntent","example":false}},"example":{"offer_id":"abc123","stripe_checkout_session_return_url":"abc123","use_stripe_checkout_session":false},"required":["offer_id"]},"SummaryInfo":{"type":"object","properties":{"sample_products_rejected":{"type":"array","items":{"$ref":"#/components/schemas/SummaryProductRejected"},"description":"Array with articles failed. Max size 30 rows","example":[{"error_code":"abc123","error_description":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"}}]},"total_products":{"type":"integer","description":"Total articles processed until the request","example":1,"format":"int64"},"total_products_imported":{"type":"integer","description":"Total articles processed in a correct way until the request","example":1,"format":"int64"},"total_products_rejected":{"type":"integer","description":"Total articles that we found an error processing it","example":1,"format":"int64"}},"example":{"sample_products_rejected":[{"error_code":"abc123","error_description":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"}}],"total_products":1,"total_products_imported":1,"total_products_rejected":1},"required":["total_products","total_products_imported","total_products_rejected","sample_products_rejected"]},"SummaryProductRejected":{"type":"object","properties":{"error_code":{"type":"string","description":"The error code","example":"abc123"},"error_description":{"type":"string","description":"The error description","example":"abc123"},"seller_product_reference":{"$ref":"#/components/schemas/SellerProductReference"}},"example":{"error_code":"abc123","error_description":"abc123","seller_product_reference":{"reference":"123ab-5343","source":"sap"}},"required":["error_code","seller_product_reference"]},"TenureLine":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/MoneyAmount"},"duration":{"type":"integer","description":"The duration in months","example":6,"enum":[0,6,12,24,30,36,48],"format":"int64"}},"example":{"amount":{"currency":"EUR","gross":119000,"net":100000},"duration":6},"required":["amount","duration"]},"TerminationFeesOps":{"type":"object","properties":{"asset_details":{"$ref":"#/components/schemas/AssetDetail"},"buy_out_fee_net":{"$ref":"#/components/schemas/MoneyValue"},"calculation_details":{"$ref":"#/components/schemas/TerminationFeesOpsCalculationDetails"},"return_fee_net":{"$ref":"#/components/schemas/MoneyValue"}},"description":"The results of calculated termination fees including the calculation details","example":{"asset_details":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","serial_number":"BA-3456786-334-9","status":"shipped","subtitle":"abc123","title":"Pro Laptop 64GB","txlog_status":"abc123"},"buy_out_fee_net":{"amount":34000,"currency":"EUR"},"calculation_details":{"buy_out_profit_loading_percent":1,"collected_rent_actual_tenure":1,"contract_start_date":"1970-01-01T00:00:01Z","difference_to_expected_revenue":1,"expected_revenue_total":1,"gross_profit_in_percent":1,"purchase_price_net":{"amount":34000,"currency":"EUR"},"rv_in_percent":1,"target_margin_in_percent":1,"tenure_actual":1,"tenure_on_contract":1,"tenure_remaining":1,"total_revenue":1,"trade_in_price":1},"return_fee_net":{"amount":34000,"currency":"EUR"}},"required":["return_fee_net","buy_out_fee_net","calculation_details"]},"TerminationFeesOpsCalculationDetails":{"type":"object","properties":{"buy_out_profit_loading_percent":{"type":"number","description":"Buy out Profit loading percent","example":1,"format":"double"},"collected_rent_actual_tenure":{"type":"integer","description":"Collected rent actual tenure","example":1,"format":"int64"},"contract_start_date":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"difference_to_expected_revenue":{"type":"integer","description":"Difference to expected revenue","example":1,"format":"int64"},"expected_revenue_total":{"type":"integer","description":"Expected revenue total","example":1,"format":"int64"},"gross_profit_in_percent":{"type":"number","description":"Gross profit in percent","example":1,"format":"double"},"purchase_price_net":{"$ref":"#/components/schemas/MoneyValue"},"rv_in_percent":{"type":"number","description":"RV in %","example":1,"format":"double"},"target_margin_in_percent":{"type":"number","description":"Target margin in %","example":1,"format":"double"},"tenure_actual":{"type":"integer","description":"Actual tenure in months","example":1,"format":"int64"},"tenure_on_contract":{"type":"integer","description":"Contract tenure in months","example":1,"format":"int64"},"tenure_remaining":{"type":"integer","description":"Remaining tenure in months","example":1,"format":"int64"},"total_revenue":{"type":"integer","description":"Total revenue","example":1,"format":"int64"},"trade_in_price":{"type":"integer","description":"Trade in price","example":1,"format":"int64"}},"example":{"buy_out_profit_loading_percent":1,"collected_rent_actual_tenure":1,"contract_start_date":"1970-01-01T00:00:01Z","difference_to_expected_revenue":1,"expected_revenue_total":1,"gross_profit_in_percent":1,"purchase_price_net":{"amount":34000,"currency":"EUR"},"rv_in_percent":1,"target_margin_in_percent":1,"tenure_actual":1,"tenure_on_contract":1,"tenure_remaining":1,"total_revenue":1,"trade_in_price":1},"required":["buy_out_profit_loading_percent","tenure_actual","tenure_on_contract","tenure_remaining"]},"TermsAndConditions":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the document","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"type":{"type":"string","description":"One of the following categories (purchase, rent , topi_care , topi_care_plus , services , data_deletion_certificate)","example":"abc123"},"url":{"type":"string","description":"Link to the document","example":"abc123"}},"example":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"},"required":["id","url","type"]},"TermsAndConditionsResult":{"type":"object","properties":{"applicable_terms_and_conditions":{"type":"array","items":{"$ref":"#/components/schemas/TermsAndConditions"},"description":"Links to the documents in the applicable language for the end customer country code","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}]},"de":{"type":"array","items":{"$ref":"#/components/schemas/TermsAndConditions"},"description":"Links to the documents in German","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}]},"en":{"type":"array","items":{"$ref":"#/components/schemas/TermsAndConditions"},"description":"Links to the documents in English","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}]},"nl":{"type":"array","items":{"$ref":"#/components/schemas/TermsAndConditions"},"description":"Links to the documents in Dutch","example":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}]}},"example":{"applicable_terms_and_conditions":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"de":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"en":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}],"nl":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","type":"abc123","url":"abc123"}]},"required":["de","nl","applicable_terms_and_conditions"]},"TradeInResult":{"type":"object","properties":{"asset_grade":{"type":"string","description":"The quality of the product","example":"abc123"},"asset_id":{"type":"string","description":"The ID of the trade in asset","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"company_name":{"type":"string","description":"Name of the company that owns this asset","example":"abc123"},"estimated_residual_amount":{"$ref":"#/components/schemas/MoneyAmount"},"finalised_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"id":{"type":"string","description":"topi trade-in ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"provider_id":{"type":"string","description":"The ID of the trade in partner","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"started_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"status":{"type":"string","description":"Trade in status","example":"abc123"},"tenure":{"type":"integer","description":"The actual tenure number","example":1,"format":"int64"},"trade_in_id":{"type":"string","description":"Trade in ID supplied by the partner","example":"abc123"},"trade_in_price_amount":{"$ref":"#/components/schemas/MoneyAmount"},"trade_in_product_id":{"type":"string","description":"The product ID from the partner side","example":"abc123"},"user_email":{"type":"string","description":"User email of this asset","example":"alice@example.com","format":"email"}},"description":"Information about a trade-in","example":{"asset_grade":"abc123","asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","company_name":"abc123","estimated_residual_amount":{"currency":"EUR","gross":119000,"net":100000},"finalised_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","started_at":"1970-01-01T00:00:01Z","status":"abc123","tenure":1,"trade_in_id":"abc123","trade_in_price_amount":{"currency":"EUR","gross":119000,"net":100000},"trade_in_product_id":"abc123","user_email":"alice@example.com"},"required":["id","status","trade_in_product_id"]},"TradeInsListResult":{"type":"object","properties":{"tradeIns":{"type":"array","items":{"$ref":"#/components/schemas/TradeInResult"},"description":"an array with the trade-ins","example":[{"asset_grade":"abc123","asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","company_name":"abc123","estimated_residual_amount":{"currency":"EUR","gross":119000,"net":100000},"finalised_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","started_at":"1970-01-01T00:00:01Z","status":"abc123","tenure":1,"trade_in_id":"abc123","trade_in_price_amount":{"currency":"EUR","gross":119000,"net":100000},"trade_in_product_id":"abc123","user_email":"alice@example.com"}]}},"example":{"tradeIns":[{"asset_grade":"abc123","asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","company_name":"abc123","estimated_residual_amount":{"currency":"EUR","gross":119000,"net":100000},"finalised_at":"1970-01-01T00:00:01Z","id":"739b63c2-9e58-4964-b38d-4ebb424de242","provider_id":"739b63c2-9e58-4964-b38d-4ebb424de242","started_at":"1970-01-01T00:00:01Z","status":"abc123","tenure":1,"trade_in_id":"abc123","trade_in_price_amount":{"currency":"EUR","gross":119000,"net":100000},"trade_in_product_id":"abc123","user_email":"alice@example.com"}]}},"TransactionLogAsset":{"type":"object","properties":{"asset_id":{"type":"string","description":"Asset ID of the asset","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"serial_number":{"type":"string","description":"Serial number of the asset in the txlog","example":"abc123"},"title":{"type":"string","description":"Title of the asset in the txlog","example":"abc123"}},"example":{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","serial_number":"abc123","title":"abc123"},"required":["asset_id","title"]},"TransactionLogAssetPayload":{"type":"object","properties":{"assets":{"type":"array","items":{"$ref":"#/components/schemas/TransactionLogAsset"},"description":"Offer status","example":[{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","serial_number":"abc123","title":"abc123"}]},"end_customer_id":{"type":"string","description":"End Customer ID attached to that asset","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"offer_id":{"type":"string","description":"Offer ID to which the asset is attached","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"transaction_date_created_at":{"type":"string","description":"When the transaction was created in the txlog","example":"abc123"},"user_id":{"type":"string","description":"User ID attached to that asset","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"assets":[{"asset_id":"739b63c2-9e58-4964-b38d-4ebb424de242","serial_number":"abc123","title":"abc123"}],"end_customer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242","transaction_date_created_at":"abc123","user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["offer_id","transaction_date_created_at","user_id","end_customer_id"]},"UnsuccessfulProductIDIngestion":{"type":"object","properties":{"line_number":{"type":"integer","description":"The line number of the CSV where it has failed","example":1,"format":"int64"},"reason":{"type":"string","description":"The reason why it has failed","example":"abc123"}},"example":{"line_number":1,"reason":"abc123"},"required":["line_number","reason"]},"UpdateAgentRequestBody":{"type":"object","properties":{"email":{"type":"string","description":"E-mail","example":"alice@example.com","format":"email"},"external_agent_id":{"type":"string","description":"Id number used to identify the sales agent in the seller's internal system","example":"abc123"},"language":{"type":"string","description":"User language","example":"abc123"},"last_login":{"type":"string","description":"User last login time","example":"1970-01-01T00:00:01Z","format":"date-time"},"name":{"type":"string","description":"Name of the agent","example":"abc123"},"phone":{"type":"string","description":"Phone number","example":"abc123"},"seller_id":{"type":"string","description":"Seller ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"seller_store_id":{"type":"string","description":"Id number used to identify the store a PoS agent is operating from","example":"abc123"},"status":{"type":"string","description":"User status","example":"abc123"},"topi_relevant":{"type":"boolean","description":"Whether the user is relevant for driving topi GMV, this allows us to opt out users that are managers or are not expected to do much sales from reporting.","example":false}},"example":{"email":"alice@example.com","external_agent_id":"abc123","language":"abc123","last_login":"1970-01-01T00:00:01Z","name":"abc123","phone":"abc123","seller_id":"739b63c2-9e58-4964-b38d-4ebb424de242","seller_store_id":"abc123","status":"abc123","topi_relevant":false},"required":["name","phone","email"]},"UpdateBrandingRequestBody":{"type":"object","properties":{"branding":{"$ref":"#/components/schemas/AddBranding"}},"example":{"branding":{"email_logo_url":"abc123","enable_transactional_emails":false,"info_hub_url":"abc123","logo_url":"abc123","name":"abc123"}},"required":["branding"]},"UpdateCustomProductsRequestBody":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"description":"Product payload","example":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"},{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}],"minItems":1}},"example":{"products":[{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"},{"base_rental_price":{"currency":"EUR","gross":119000,"net":100000},"categorization_suggestions":[{"category":"abc123","confidence":1,"model_name":"abc123","model_version":"abc123"}],"description":"aaa","extra_details":[{"property":"memory","value":"16GB DDR5"}],"id":"739b63c2-9e58-4964-b38d-4ebb424de242","image":{"url":"https://example.com/foo"},"is_active":false,"is_fully_reviewed":false,"list_price":{"currency":"EUR","gross":119000,"net":100000},"manufacturer":"abc123","origin":"abc123","origin_seller":"abc123","origin_seller_references":[{"reference":"123ab-5343","source":"sap"}],"pretty_id":"abc123","pricing_category":"iphone_17_pro","pricing_category_confidence":1,"pricing_input_information":{"headroom_info":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}],"pricing_category":"abc123","pricing_category_confidence":1},"product_standard_identifiers":[{"id":"123ab-4567","identifier_type":"EAN"}],"publicized_price":{"currency":"EUR","gross":119000,"net":100000},"review_status":"unsupported","seller_categories":[{"id":"abc123","name":"abc123","parent_category":"abc123"}],"seller_product_references":[{"reference":"123ab-5343","source":"sap"},{"reference":"123ab-5343","source":"sap"}],"seller_product_type":"software","shop_product_description_url":"https://example.com/foo","subtitle":"abc123","title":"abc123"}]},"required":["products"]},"UpdateCustomerEmailOpsRequestBody":{"type":"object","properties":{"is_dry_run":{"type":"boolean","default":true,"example":false},"rows":{"type":"array","items":{"$ref":"#/components/schemas/UpdateEmailPayload"},"example":[{"email":"abc123","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}},"example":{"is_dry_run":false,"rows":[{"email":"abc123","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}},"UpdateCustomerEmailOpsResponseBody":{"type":"object","properties":{"failed":{"type":"array","items":{"$ref":"#/components/schemas/CustomerUpdateFailed"},"example":[{"offer_id":"abc123","reason":"abc123"}]},"failed_count":{"type":"integer","example":1,"format":"int64"},"updated_customers_count":{"type":"integer","example":1,"format":"int64"}},"example":{"failed":[{"offer_id":"abc123","reason":"abc123"}],"failed_count":1,"updated_customers_count":1},"required":["updated_customers_count","failed_count"]},"UpdateEmailPayload":{"type":"object","properties":{"email":{"type":"string","example":"abc123"},"offer_id":{"type":"string","description":"Offer ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"email":"abc123","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["offer_id","email"]},"UpdateEmailRequestBody":{"type":"object","properties":{"current_email":{"type":"string","example":"alice@example.com","format":"email"},"new_email":{"type":"string","example":"alice@example.com","format":"email"}},"example":{"current_email":"alice@example.com","new_email":"alice@example.com"},"required":["current_email","new_email"]},"UpdateEndCustomerInfoOpsRequestBody":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"company_address":{"$ref":"#/components/schemas/Address"},"company_registration_number":{"type":"string","description":"end-customer Company Registration Number","example":"abc123"},"email_domain":{"type":"string","description":"End Customer Email Domain","example":"abc123"},"force_update_email":{"type":"boolean","description":"Force update the Email Domain","example":false},"group":{"type":"string","description":"End Customer Company Group","example":"abc123"},"language":{"type":"string","description":"end-customer language (in ISO 639-1 format)","example":"de"},"name":{"type":"string","description":"end-customer name","example":"aa","minLength":1},"not_vat_registered":{"type":"boolean","description":"end-customer declared it has no VAT number","example":false},"tax_number":{"type":"string","description":"end-customer tax number","example":"abc123"},"type":{"type":"string","description":"end-customer type","example":"Partnership","enum":["Sole proprietorship","Partnership","Corporation","Limited Liability Company (LLC)"]},"vat_number":{"type":"string","description":"end-customer VAT number","example":"abc123"}},"example":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_registration_number":"abc123","email_domain":"abc123","force_update_email":false,"group":"abc123","language":"de","name":"aa","not_vat_registered":false,"tax_number":"abc123","type":"Partnership","vat_number":"abc123"},"required":["name","billing_address"]},"UpdateHeadroomsRequestBody":{"type":"object","properties":{"headrooms":{"type":"array","items":{"$ref":"#/components/schemas/Headroom"},"example":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}]}},"example":{"headrooms":[{"expected_residual_value_ratio":1,"headroom_ratio":1,"is_default":false,"tenure":1}]}},"UpdateOpsCreditLimitsRequestBody":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/CreditLimitItem"},"description":"Rows to add or update the credit limits","example":[{"available_credit_limit":1,"available_credit_limit_currency":"abc123","comments":"abc123","credit_limit":1,"credit_limit_currency":"abc123","end_customer_id":"abc123"}]}},"example":{"rows":[{"available_credit_limit":1,"available_credit_limit_currency":"abc123","comments":"abc123","credit_limit":1,"credit_limit_currency":"abc123","end_customer_id":"abc123"}]},"required":["rows"]},"UpdatePricingCategoriesRequestBody":{"type":"object","properties":{"pricing_category_updates":{"type":"array","items":{"$ref":"#/components/schemas/UpdatePricingCategoryProduct"},"example":[{"pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}},"example":{"pricing_category_updates":[{"pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}]}},"UpdatePricingCategoryProduct":{"type":"object","properties":{"pricing_category":{"type":"string","description":"The pricing category that should be assigned","example":"iphone_17_pro","enum":["iphone_17","iphone_17_pro","iphone_17_pro_max","iphone_air","iphone_17_e","iphone_16_pro_max","iphone_16_pro","iphone_16_plus","iphone_16","iphone_15_pro_max","iphone_15_pro","iphone_15_plus","iphone_15","iphone_14_pro_max","iphone_14_pro","iphone_14_plus","iphone_14","iphone_13_pro_max","iphone_13_pro","iphone_13","iphone_12","iphone_11","iphone_se_22","iphone_se_20","macbook_pro_13_14","macbook_pro_13_14_m3","macbook_pro_13_14_m4","macbook_pro_13_14_m5","macbook_pro_15_16","macbook_pro_15_16_m3","macbook_pro_15_16_m4","macbook_pro_15_16_m5","macbook_air","macbook_air_13_m5","macbook_air_15_m5","macbook_neo","mac_desktop","mac_desktop_m4","mac_studio","mac_pro_m2","apple_display","studio_display_2026","studio_display_2022","studio_display_xdr","ipad_pro","ipad_pro_m5","ipad_pro_m4","ipad_pro_12_9_inch_7_gen","ipad_pro_12_9_inch_6_gen","ipad_pro_12_9_inch_5_gen","ipad_pro_11_inch_4_gen","ipad_air","ipad_air_m4","ipad_air_m3","ipad_air_6_gen","ipad_air_5_gen","ipad_air_4_gen","ipad_regular","ipad_regular_11_gen","ipad_regular_10_gen","ipad_regular_9_gen","ipad_mini","ipad_mini_6_gen","smartwatch_apple","smartwatch_apple_ultra","smartwatch_other","laptop_other_top","laptop_other_low","desktop_other_top","desktop_other_low","phone_other_top","phone_other_low","tablet_other_top","tablet_other_low","screen","accessory_other","accessory_airpods","accessory_pencil","accessory_homepod","accessory_visionpro","services_insurance","software","services_management","printer","iphone_16_e","server","network_security","mac_pro","mac_studio_m3","mac_studio_m4","accessory_smartfolio","accessory_appletv","accessory_gpu",""]},"pricing_category_confidence":{"type":"integer","description":"Optional confidence of the category classification","example":1,"format":"int64","minimum":0,"maximum":100},"product_id":{"type":"string","description":"The id of the product","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"pricing_category":"iphone_17_pro","pricing_category_confidence":1,"product_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["product_id","pricing_category"]},"UpdateProductSuggestion":{"type":"object","properties":{"suggestion_weight":{"type":"integer","description":"The weight of the suggestion","example":1,"format":"int64"}},"example":{"suggestion_weight":1},"required":["suggestion_weight"]},"UpdateSellerLogoPayload":{"type":"object","properties":{"logo_image":{"type":"string","description":"Base64 encoded logo image to upload","example":"abc123"},"mime_type":{"type":"string","description":"the mime type of the logo.","example":"abc123"},"seller_id":{"type":"string","description":"the seller to update","example":"abc123"}},"description":"Payload to update the seller logo","example":{"logo_image":"abc123","mime_type":"abc123","seller_id":"abc123"},"required":["seller_id","logo_image","mime_type"]},"UpdateSellerPayload":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"can_provide_serial_numbers":{"type":"boolean","description":"If the seller can provide serial number for assets","example":false},"can_use_parent_catalog":{"type":"boolean","description":"Allow the seller to use the parent catalog?","example":false},"capability_add_custom_products":{"type":"boolean","description":"If the seller can add custom products","example":false},"capability_anonymized_pricing":{"type":"boolean","description":"If the seller wishes to anonymize catalog prices","example":false},"capability_anonymous_ecom_offer_creation":{"type":"boolean","description":"Ability to skip required shipping address for ecom offers.","example":false},"capability_bundles":{"type":"boolean","description":"If the seller has bundles enabled","example":false},"capability_central_catalog":{"type":"boolean","description":"enable or disable central catalog","example":false},"capability_chatbot_id":{"type":"string","description":"Chatbot id for the seller. This enables a chatbase chatbot for the seller","example":"abc123"},"capability_dual_pricing":{"type":"boolean","description":"If the seller can set dual pricing","example":false},"capability_email_end_customer_on_offer_created":{"type":"boolean","description":"Ability to email the end customers when offers are created","example":false},"capability_hide_buy_now":{"type":"boolean","description":"If the seller should hide purchase only as option.","example":false},"capability_international_shipment":{"type":"boolean","description":"If the seller has international shipment enabled","example":false},"capability_show_ecom_orders":{"type":"boolean","description":"Show ecommerce orders to all telesales","example":false},"cc_ecommerce_is_active":{"type":"boolean","description":"If we should send notifications to the seller's CC email addresses when the channel is ecommerce","example":false},"cc_offer_accepted":{"type":"string","description":"The email addresses to send notifications when an offer is accepted separated by comma","example":"abc123"},"cc_offer_created":{"type":"string","description":"The email addresses to send notifications when an offer is created separated by comma","example":"abc123"},"cc_offer_declined":{"type":"string","description":"The email addresses to send notifications when an offer is declined separated by comma","example":"abc123"},"cc_telesales_is_active":{"type":"boolean","description":"If we should send notifications to the seller's CC email addresses when the channel is telesales","example":false},"email":{"type":"string","description":"The email for contacting the seller customer service","example":"aa","minLength":1,"maxLength":255},"erp_integrated":{"type":"boolean","description":"If the seller is ERP integrated","example":false},"external_contractual_entity":{"type":"string","description":"The external contractual entity name (e.g. peac)","example":"abc123"},"external_id":{"type":"string","description":"The external ID assigned by the contractual entity partner","example":"abc123"},"kickback_ratio":{"type":"number","description":"The kickback ratio for the seller","example":1,"format":"double"},"logo_url":{"type":"string","description":"The url of the seller logo","example":"abc123"},"name":{"type":"string","description":"The name of the seller","example":"aa","minLength":1,"maxLength":255},"parent_seller_id":{"type":"string","description":"The ID of the parent seller, we use this for multipliers","example":"abc123"},"pdf_reader_assistant_id":{"type":"string","description":"The assistant ID to use for PDF reader, use null to disable PDF reader","example":"abc123"},"pretty_name":{"type":"string","description":"The pretty, user-facing name of the seller","example":"aa","minLength":1,"maxLength":255},"product_reference_source":{"type":"string","description":"The database/software/system that the Seller use to manage their products, ex. SKU/SAP","example":"aa","minLength":1,"maxLength":255},"risk_status":{"type":"string","description":"The risk assessment status for the external contractual entity","example":"approved","enum":["pending","approved","declined"]},"shipping_method_name":{"type":"string","description":"the name of the shipping method","example":"abc123"},"shipping_method_seller_reference":{"type":"string","description":"the reference of the shipping method in the seller","example":"abc123"},"status_changed_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"widget_id":{"type":"string","description":"The widget ID of the seller","example":"abc123"}},"example":{"address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"can_provide_serial_numbers":false,"can_use_parent_catalog":false,"capability_add_custom_products":false,"capability_anonymized_pricing":false,"capability_anonymous_ecom_offer_creation":false,"capability_bundles":false,"capability_central_catalog":false,"capability_chatbot_id":"abc123","capability_dual_pricing":false,"capability_email_end_customer_on_offer_created":false,"capability_hide_buy_now":false,"capability_international_shipment":false,"capability_show_ecom_orders":false,"cc_ecommerce_is_active":false,"cc_offer_accepted":"abc123","cc_offer_created":"abc123","cc_offer_declined":"abc123","cc_telesales_is_active":false,"email":"aa","erp_integrated":false,"external_contractual_entity":"abc123","external_id":"abc123","kickback_ratio":1,"logo_url":"abc123","name":"aa","parent_seller_id":"abc123","pdf_reader_assistant_id":"abc123","pretty_name":"aa","product_reference_source":"aa","risk_status":"approved","shipping_method_name":"abc123","shipping_method_seller_reference":"abc123","status_changed_at":"1970-01-01T00:00:01Z","widget_id":"abc123"},"required":["name","pretty_name","email","product_reference_source","address","shipping_method_name","shipping_method_seller_reference","capability_central_catalog","capability_dual_pricing","erp_integrated","can_provide_serial_numbers","capability_hide_buy_now","capability_anonymized_pricing","capability_bundles","capability_show_ecom_orders","capability_email_end_customer_on_offer_created","capability_anonymous_ecom_offer_creation","capability_international_shipment"]},"UpdateServicePricesRequestBody":{"type":"object","properties":{"service_prices":{"$ref":"#/components/schemas/NewPricingCategoryServicePrices"}},"example":{"service_prices":{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","service_prices":[{"id":"739b63c2-9e58-4964-b38d-4ebb424de242","price":1}]}}},"UpdateShippingAddressWithEndCustomerInfoRequestBody":{"type":"object","properties":{"end_customer":{"$ref":"#/components/schemas/EndCustomerUpdate"},"end_user":{"$ref":"#/components/schemas/EndUserUpdate"},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"}},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"}},"required":["shipping_address","end_customer","end_user"]},"UpdateShippingAddressWithEndCustomerInfoResult":{"type":"object","properties":{"end_customer":{"$ref":"#/components/schemas/EndCustomerWithPSPProvider"},"end_user":{"$ref":"#/components/schemas/EndUser"},"offer":{"$ref":"#/components/schemas/OfferForEndCustomer"},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"}},"example":{"end_customer":{"billing_address":{"city":"abc123","country_code":"DE","line1":"abc123","line2":"aaa","postal_code":"abc123","region":"abc123"},"company_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"},"company_registration_number":"123456789","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"}},"required":["end_customer","end_user","shipping_address"]},"UpdateStatusRequestBody":{"type":"object","properties":{"state":{"type":"string","description":"Product payload","example":"shipped","enum":["created","shipped","return_completed","purchased","ops_canceled"]}},"example":{"state":"shipped"},"required":["state"]},"UploadLogoPayload":{"type":"object","properties":{"logo_image":{"type":"string","description":"Base64 encoded image to upload","example":"abc123"},"mime_type":{"type":"string","description":"the mime type of the logo.","example":"abc123"}},"example":{"logo_image":"abc123","mime_type":"abc123"},"required":["logo_image","mime_type"]},"UserIDPayload":{"type":"object","properties":{"user_id":{"type":"string","description":"end-user ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"user_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["user_id"]},"UserSummary":{"type":"object","properties":{"email":{"type":"string","description":"the user email","example":"abc123"},"name":{"type":"string","description":"the user complete name","example":"abc123"}},"example":{"email":"abc123","name":"abc123"},"required":["name","email"]},"UserSummaryForOps":{"type":"object","properties":{"created_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"},"email":{"type":"string","description":"user's email address","example":"abc123"},"email_verified":{"type":"boolean","description":"whether the user has verified their email","example":false},"id":{"type":"string","description":"user ID","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"},"marketing_accepted":{"type":"boolean","description":"whether the user accepted the marketing terms","example":false},"terms_accepted":{"type":"boolean","description":"whether the user has accepted our terms of use","example":false},"terms_accepted_at":{"type":"string","example":"1970-01-01T00:00:01Z","format":"date-time"}},"example":{"created_at":"1970-01-01T00:00:01Z","email":"abc123","email_verified":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","marketing_accepted":false,"terms_accepted":false,"terms_accepted_at":"1970-01-01T00:00:01Z"},"required":["id","created_at","email","email_verified","terms_accepted","marketing_accepted"]},"UserWithEndCustomerID":{"type":"object","properties":{"end_customer_id":{"type":"string","description":"end customer id","example":"abc123"},"user":{"$ref":"#/components/schemas/UserSummaryForOps"}},"example":{"end_customer_id":"abc123","user":{"created_at":"1970-01-01T00:00:01Z","email":"abc123","email_verified":false,"id":"739b63c2-9e58-4964-b38d-4ebb424de242","marketing_accepted":false,"terms_accepted":false,"terms_accepted_at":"1970-01-01T00:00:01Z"}},"required":["user","end_customer_id"]},"ValidateDiscountRequest":{"type":"object","properties":{"discount_code":{"type":"string","example":"abc123"},"oauth_token":{"type":"string","description":"OAuth2 access token used to perform authorization","example":"abc123"},"offer_id":{"type":"string","description":"Offer ID to validate this discount code against","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"discount_code":"abc123","oauth_token":"abc123","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["discount_code","offer_id","oauth_token"]},"ValidateDiscountRequest2":{"type":"object","properties":{"discount_code":{"type":"string","example":"abc123"},"offer_id":{"type":"string","description":"Offer ID to validate this discount code against","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"discount_code":"abc123","offer_id":"739b63c2-9e58-4964-b38d-4ebb424de242"},"required":["discount_code","offer_id"]},"ValidateResponseBody":{"type":"object","properties":{"is_valid":{"type":"boolean","example":false}},"example":{"is_valid":false},"required":["is_valid"]},"ValidationError":{"type":"object","properties":{"code":{"type":"string","description":"Error code","example":"abc123"},"field":{"type":"string","description":"Field name","example":"abc123"},"message":{"type":"string","description":"Error message","example":"abc123"}},"example":{"code":"abc123","field":"abc123","message":"abc123"},"required":["field","code","message"]},"ValidationErrorList":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"},"description":"List of errors","example":[{"code":"abc123","field":"abc123","message":"abc123"}]},"message":{"type":"string","description":"Error message","example":"abc123"}},"example":{"errors":[{"code":"abc123","field":"abc123","message":"abc123"}],"message":"abc123"},"required":["errors","message"]},"VoidOpsRequestBody":{"type":"object","properties":{"allow_pending_review":{"type":"boolean","description":"Allow voiding even if the offer is currently pending review","default":false,"example":false},"superseded_by_id":{"type":"string","description":"The topi offer ID of the offer that supersedes this voided one","example":"739b63c2-9e58-4964-b38d-4ebb424de242","format":"regexp","pattern":"^[0-9A-Za-z\\-]+$"}},"example":{"allow_pending_review":false,"superseded_by_id":"739b63c2-9e58-4964-b38d-4ebb424de242"}},"WaitlistSignUpPayload":{"type":"object","properties":{"company_name":{"type":"string","description":"Customer's company name","example":"aaa","maxLength":128},"email":{"type":"string","description":"Customer e-mail","example":"aaa","format":"email","maxLength":128},"first_name":{"type":"string","description":"Customer's first name","example":"aaa","maxLength":128},"last_name":{"type":"string","description":"Customer's last name","example":"aaa","maxLength":128},"phone":{"type":"string","description":"Customer's phone number","example":"aaa","maxLength":128},"seller":{"type":"string","description":"Seller the customer will be redirected to purchase devices","example":"aaa","maxLength":128}},"example":{"company_name":"aaa","email":"aaa","first_name":"aaa","last_name":"aaa","phone":"aaa","seller":"aaa"},"required":["email"]}},"securitySchemes":{"OAuth2Topi_header_Authorization":{"type":"oauth2","description":"Use OAuth2 to authenticate","flows":{"authorizationCode":{"authorizationUrl":"/oauth2/authorize","tokenUrl":"/oauth2/token","refreshUrl":"/oauth2/token","scopes":{"branding:read":"view branding details","catalog:edit":"add product to catalog","catalog:read":"view and search catalog","discount:edit":"mutate ops discount","discount:read":"read ops discount","offer:edit":"customize and accept offers","offer:read":"view offers","ops-branding:edit":"add branding to a seller","ops-branding:read":"view and search branding configs","ops-end-customer:edit":"read ops decision methods","ops-end-customer:read":"read ops end customer methods","ops-invoice:edit":"edit ops invoices","ops-invoice:read":"read ops invoices","ops-offer:edit":"update existing offers","ops-offer:read":"read offer details","ops-order:edit":"edit order details","ops-order:read":"read order details","ops-pricing-category:edit":"add pricing categories","ops-pricing-category:read":"view and search pricing categories","ops-seller:edit":"update existing sellers","ops-seller:read":"read seller details","ops-shipping-method:edit":"edit shipping methods details","ops-shipping-method:read":"read shipping methods","ops-trade-in:edit":"edit trade ins","ops-trade-in:read":"read trade ins","ops-user:edit":"edit user details","ops-user:read":"read user details","payment_method:edit":"add payment method","reminder:edit":"edit reminder system elements"}}}},"jwt_header_Authorization":{"type":"http","description":"JWT security for pubsub","scheme":"bearer","bearerFormat":"JWT"}}},"tags":[{"name":"allowlist","description":"Customer allowlist"},{"name":"crm"},{"name":"discount","description":"Offer Discounts Service"},{"name":"feedback","description":"Provide feedback to topi"},{"name":"invoice","description":"Invoices from end customers"},{"name":"catalog","description":"Topi catalog for sellers"},{"name":"branding","description":"Topi branding for sellers"},{"name":"end_customer","description":"end customer api calls"},{"name":"Asset","description":"asset management"},{"name":"offer","description":"Offers from sales agents"},{"name":"order","description":"Orders"},{"name":"organizations","description":"service for managing auth0 organizations and their members"},{"name":"payment-method","description":"Payment Method used for payments"},{"name":"pricing-category","description":"Topi pricing categories"},{"name":"reminder","description":"Reminder System Service"},{"name":"rental_item_events","description":"Rental item events - handles PubSub push events for rental item terminations"},{"name":"portal_sales_agents","description":"Manage sales agents in seller portal"},{"name":"seller","description":"Sellers information"},{"name":"seller_oauth","description":"Manage seller OAuth credentials for API access"},{"name":"shipping-method-ops","description":"Shipping methods of the sellers"},{"name":"user","description":"Operations related with the user"},{"name":"waitlist","description":"Customer waitlist"},{"name":"Trade in"}]}