Last active
March 26, 2019 19:29
-
-
Save nathanstilwell/7d83594907370e522a4ae2af17497616 to your computer and use it in GitHub Desktop.
Flow public api as openapi version 3.0.2
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "components": { | |
| "schemas": { | |
| "account_orders_export_type": { | |
| "properties": { | |
| "statement_id": { | |
| "type": "string" | |
| }, | |
| "transaction_summary_id": { | |
| "type": "string" | |
| }, | |
| "transaction_created_from": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "transaction_created_to": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "transaction_created_on_or_after": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "transaction_created_after": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "transaction_created_on_or_before": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "transaction_created_before": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "transaction_posted_from": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "transaction_posted_to": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "transaction_posted_on_or_after": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "transaction_posted_after": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "transaction_posted_on_or_before": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "transaction_posted_before": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "account_transactions_export_type": { | |
| "properties": { | |
| "statement_id": { | |
| "type": "string" | |
| }, | |
| "transaction_summary_id": { | |
| "type": "string" | |
| }, | |
| "created_from": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "created_to": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "created_on_or_after": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "created_after": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "created_on_or_before": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "created_before": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "posted_from": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "posted_to": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "posted_on_or_after": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "posted_after": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "posted_on_or_before": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "posted_before": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ach_authorization_form": { | |
| "description": "Used for initiating an ACH (Automated Clearing House) bank transfer.", | |
| "properties": { | |
| "account_owner_name": { | |
| "type": "string" | |
| }, | |
| "account_number": { | |
| "type": "string" | |
| }, | |
| "routing_number": { | |
| "type": "string" | |
| }, | |
| "billing_address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "address": { | |
| "description": "Defines structured fields for address to be used in user/form input. Either text or the structured input needs to be present.", | |
| "properties": { | |
| "text": { | |
| "type": "string" | |
| }, | |
| "streets": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "street_number": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "province": { | |
| "type": "string" | |
| }, | |
| "postal": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "address_suggestion": { | |
| "description": "A suggested address (usually providing more accurate information). This object contains both the suggested address as well as metadata on which fields are actually different", | |
| "properties": { | |
| "address": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "streets": { | |
| "type": "boolean" | |
| }, | |
| "city": { | |
| "type": "boolean" | |
| }, | |
| "province": { | |
| "type": "boolean" | |
| }, | |
| "postal": { | |
| "type": "boolean" | |
| }, | |
| "country": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "address_verification": { | |
| "description": "Address verification returns information on whether or not an address is valid and deliverable - meaning carriers will accept this address. Also returns suggestions for address correction, including data to highlight specific fields to correct.", | |
| "properties": { | |
| "address": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "valid": { | |
| "type": "boolean" | |
| }, | |
| "suggestions": { | |
| "items": { | |
| "$ref": "#/components/schemas/address_suggestion" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "adjustment_reason": { | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/adjustment_reason_key" | |
| }, | |
| "label": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "allocation": { | |
| "properties": { | |
| "order": { | |
| "$ref": "#/components/schemas/allocation_order_summary" | |
| }, | |
| "details": { | |
| "items": { | |
| "$ref": "#/components/schemas/allocation_detail" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "deprecated": true, | |
| "type": "object" | |
| }, | |
| "allocation_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "allocation_detail_component": { | |
| "description": "Represents any component that is not VAT or duty, such as item price, rounding, shipping, etc.", | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/order_price_detail_component_key" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "allocation_levy_component": { | |
| "description": "Represents either a VAT or duty component.", | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/order_price_detail_component_key" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "rate": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "allocation_line_detail": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "key": { | |
| "$ref": "#/components/schemas/order_price_detail_key" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "included": { | |
| "items": { | |
| "$ref": "#/components/schemas/allocation_component" | |
| }, | |
| "type": "array" | |
| }, | |
| "not_included": { | |
| "items": { | |
| "$ref": "#/components/schemas/allocation_component" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "allocation_order_detail": { | |
| "description": "Represents an order-specific detail such as shipping, insurance, or an order-level discount.", | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/order_price_detail_key" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "included": { | |
| "items": { | |
| "$ref": "#/components/schemas/allocation_component" | |
| }, | |
| "type": "array" | |
| }, | |
| "not_included": { | |
| "items": { | |
| "$ref": "#/components/schemas/allocation_component" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "allocation_order_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "submitted_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "allocation_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "allocation": { | |
| "$ref": "#/components/schemas/allocation_v2" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "allocation_v2": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/allocation_order_summary" | |
| }, | |
| "details": { | |
| "items": { | |
| "$ref": "#/components/schemas/allocation_detail" | |
| }, | |
| "type": "array" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/localized_total" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "amount_margin": { | |
| "description": "Rule outcome where shipping surfaced in quote is actual cost plus a predefined margin price", | |
| "properties": { | |
| "margin": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "amount_margin_form": { | |
| "properties": { | |
| "margin": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "analytics_export_type": { | |
| "properties": { | |
| "from": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "to": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "interval": { | |
| "$ref": "#/components/schemas/unit_of_time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "apple_pay_merchant_validation_payload": { | |
| "properties": { | |
| "validation_url": { | |
| "type": "string" | |
| }, | |
| "display_name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "at_cost": { | |
| "description": "Rule outcome where shipping surfaced in quote is actual cost of the service", | |
| "properties": { | |
| "ignore": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "attribute": { | |
| "description": "An attribute can be configured to be used in different ways throughout Flow. A common example is to identify a meaningful attribute (e.g. brand) that can then be displayed throughout the Flow console.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "options": { | |
| "$ref": "#/components/schemas/options" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "intent": { | |
| "$ref": "#/components/schemas/attribute_intent" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/attribute_data_type" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "attribute_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "attribute_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "attribute_form": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "options": { | |
| "$ref": "#/components/schemas/options" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "intent": { | |
| "$ref": "#/components/schemas/attribute_intent" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/attribute_data_type" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "attribute_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "intent": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "attribute_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "attribute": { | |
| "$ref": "#/components/schemas/attribute" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "attribute_version": { | |
| "description": "Retrieve journaled history of an attribute", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "attribute": { | |
| "$ref": "#/components/schemas/attribute" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authentication_form": { | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_copy_form": { | |
| "description": "Creates a new authorization based on the underlying information in an existing authorization. A common use case here is to create a new auth when the existing one has expired.", | |
| "properties": { | |
| "source_authorization_key": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_error": { | |
| "description": "Details for why an authorization was not created", | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/authorization_decline_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "avs": { | |
| "$ref": "#/components/schemas/avs" | |
| }, | |
| "cvv": { | |
| "$ref": "#/components/schemas/cvv" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_order_reference": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_payload": { | |
| "description": "Used to complete an inline authorization like Google Pay or Apple Pay.", | |
| "properties": { | |
| "parameters": { | |
| "$ref": "#/components/schemas/authorization_payload_parameters" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/authorization_order_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_result": { | |
| "description": "Contains the result of the authorization. If an immediate response is not available, the state will be 'pending' - this usually indicates fraud review requires additional time / verification (or a potential network issue with the issuing bank).", | |
| "properties": { | |
| "status": { | |
| "$ref": "#/components/schemas/authorization_status" | |
| }, | |
| "action": { | |
| "$ref": "#/components/schemas/authorization_result_action" | |
| }, | |
| "decline_code": { | |
| "$ref": "#/components/schemas/authorization_decline_code" | |
| }, | |
| "avs": { | |
| "$ref": "#/components/schemas/avs" | |
| }, | |
| "cvv": { | |
| "$ref": "#/components/schemas/cvv" | |
| }, | |
| "three_d_secure": { | |
| "$ref": "#/components/schemas/three_d_secure" | |
| }, | |
| "description": { | |
| "$ref": "#/components/schemas/authorization_result_description" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_result_action": { | |
| "description": "Provides details for how to acquire additional information from the customer when needed (e.g. redirecting to the issuer for online payment method or 3D Secure).", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/authorization_result_action_type" | |
| }, | |
| "url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_result_description": { | |
| "properties": { | |
| "display": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_status_changed": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/authorization" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "authorization_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/authorization" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "available_filter_structured": { | |
| "properties": { | |
| "field": { | |
| "type": "string" | |
| }, | |
| "operators": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "format": { | |
| "$ref": "#/components/schemas/available_filter_format" | |
| }, | |
| "valid_values": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "placeholder": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "available_filter_unstructured": { | |
| "properties": { | |
| "placeholder": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "available_promotion": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "shipping_configuration": { | |
| "$ref": "#/components/schemas/shipping_configuration_reference" | |
| }, | |
| "region": { | |
| "$ref": "#/components/schemas/region_reference" | |
| }, | |
| "promotions": { | |
| "items": { | |
| "$ref": "#/components/schemas/promotion" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "available_promotions_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "available_promotions_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "available_promotion": { | |
| "$ref": "#/components/schemas/available_promotion" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "available_promotions_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| }, | |
| "available_promotions": { | |
| "items": { | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "available_promotions_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "available_promotion": { | |
| "$ref": "#/components/schemas/available_promotion" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "available_service": { | |
| "description": "Representation of a service level available at a center and the special pickup times during the week. If pickup schedules are not provided, assumption is once a day during the weekdays.", | |
| "properties": { | |
| "service": { | |
| "type": "string" | |
| }, | |
| "scheduled_pickups": { | |
| "items": { | |
| "$ref": "#/components/schemas/scheduled_pickup" | |
| }, | |
| "type": "array" | |
| }, | |
| "lead_days": { | |
| "$ref": "#/components/schemas/number_range" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "avs": { | |
| "description": "Represents the address verification results", | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/avs_code" | |
| }, | |
| "name": { | |
| "type": "boolean" | |
| }, | |
| "address": { | |
| "type": "boolean" | |
| }, | |
| "postal": { | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "b2b_invoice": { | |
| "description": "The b2b invoice represents a transaction between Flow and one of our clients (e.g. Flow purchasing inventory to resell to a consumer).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "buyer": { | |
| "$ref": "#/components/schemas/merchant_of_record_entity" | |
| }, | |
| "seller": { | |
| "$ref": "#/components/schemas/merchant_of_record_entity" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/consumer_invoice_status" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/consumer_invoice_order_summary" | |
| }, | |
| "economic_title_location": { | |
| "$ref": "#/components/schemas/economic_title_location" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/consumer_invoice_center_reference" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| }, | |
| "tax": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "lines": { | |
| "items": { | |
| "$ref": "#/components/schemas/consumer_invoice_line" | |
| }, | |
| "type": "array" | |
| }, | |
| "documents": { | |
| "items": { | |
| "$ref": "#/components/schemas/consumer_invoice_document" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "b2b_invoice_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "b2b_invoice": { | |
| "$ref": "#/components/schemas/b2b_invoice" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "b2b_invoice_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "b2b_invoice": { | |
| "$ref": "#/components/schemas/b2b_invoice" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "behavior_audit": { | |
| "properties": { | |
| "behavior": { | |
| "$ref": "#/components/schemas/flow_behavior" | |
| }, | |
| "authentication_techniques": { | |
| "items": { | |
| "$ref": "#/components/schemas/authentication_technique" | |
| }, | |
| "type": "array" | |
| }, | |
| "roles": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_role" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "billing_address": { | |
| "properties": { | |
| "name": { | |
| "$ref": "#/components/schemas/name" | |
| }, | |
| "streets": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "province": { | |
| "type": "string" | |
| }, | |
| "postal": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "company": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "browse_optin_responses": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "session_id": { | |
| "type": "string" | |
| }, | |
| "optin_responses": { | |
| "items": { | |
| "$ref": "#/components/schemas/optin_response" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "browse_optin_responses_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "browse_optin_responses_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "browse_optin_responses": { | |
| "$ref": "#/components/schemas/browse_optin_responses" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture": { | |
| "description": "Capture actually transfers funds. You can capture as many times as you'd like up until the total amount of the authorization has been captured or the authorization otherwise becomes unavailable (e.g. expires).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/authorization_reference" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "requested": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/capture_status" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "capture": { | |
| "$ref": "#/components/schemas/capture" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture_error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/generic_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "decline_code": { | |
| "$ref": "#/components/schemas/capture_decline_code" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture_form": { | |
| "description": "Capture actually transfers funds. You can capture as many times as you'd like up until the total amount of the authorization has been captured or the authorization otherwise becomes unavailable (e.g. expires).", | |
| "properties": { | |
| "authorization_id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture_identifier": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "capture": { | |
| "$ref": "#/components/schemas/capture_reference" | |
| }, | |
| "identifier": { | |
| "type": "string" | |
| }, | |
| "primary": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture_identifier_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "identifier": { | |
| "$ref": "#/components/schemas/capture_identifier" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture_identifier_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "identifier": { | |
| "$ref": "#/components/schemas/capture_identifier" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "capture": { | |
| "$ref": "#/components/schemas/capture" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "capture_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "capture": { | |
| "$ref": "#/components/schemas/capture" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card": { | |
| "description": "Card represents the metadata about a secure, tokenized card. The card 'token' is a unique, cryptographically secure token by which this card can be identified in the future. The card token itself will either be a permanent card token (denoted by a prefix of F96) or a one time nonce (denoted by a prefix of F17). Nonces represent cards that were encrypted from public channels (like the user's browser via JavaScript) and can be used once only. If you have a nonce you can exchange it for a permanent card token via the operation POST /:organization/cards/nonces", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "token": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/card_type" | |
| }, | |
| "expiration": { | |
| "$ref": "#/components/schemas/expiration" | |
| }, | |
| "iin": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "$ref": "#/components/schemas/issuer_summary" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_authorization": { | |
| "description": "An authorization is used to check and reserve funds w/ a given payment method. No funds are actually transferred; once you have you an authorization, you can capture up to the amount of the authorization.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "merchant_of_record": { | |
| "$ref": "#/components/schemas/merchant_of_record" | |
| }, | |
| "method": { | |
| "$ref": "#/components/schemas/payment_method" | |
| }, | |
| "card": { | |
| "$ref": "#/components/schemas/expandable_card" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "requested": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "customer": { | |
| "$ref": "#/components/schemas/customer" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "billing_address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/authorization_order_reference" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "result": { | |
| "$ref": "#/components/schemas/authorization_result" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "expires_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_authorization_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/card_authorization" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_authorization_upserted_v2": { | |
| "description": "Represents an authorization for a card payment method", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/card_authorization" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "card": { | |
| "$ref": "#/components/schemas/card" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_error": { | |
| "description": "Details for why a card was not created", | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/card_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "avs": { | |
| "$ref": "#/components/schemas/avs" | |
| }, | |
| "cvv": { | |
| "$ref": "#/components/schemas/cvv" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_form": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "cipher": { | |
| "type": "string" | |
| }, | |
| "expiration_month": { | |
| "type": "integer" | |
| }, | |
| "expiration_year": { | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "cvv": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "challenge_text": { | |
| "type": "string" | |
| }, | |
| "challenge_cipher": { | |
| "type": "string" | |
| }, | |
| "token_type": { | |
| "$ref": "#/components/schemas/token_type" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_nonce_form": { | |
| "description": "The card nonce form presents a one time token to exchange server side for a permanent, secure tokenized card", | |
| "properties": { | |
| "token": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "token": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_summary": { | |
| "description": "Card Summary is the card without the token", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/card_type" | |
| }, | |
| "expiration": { | |
| "$ref": "#/components/schemas/expiration" | |
| }, | |
| "iin": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "$ref": "#/components/schemas/issuer_summary" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_token_form": { | |
| "properties": { | |
| "token": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "card": { | |
| "$ref": "#/components/schemas/card" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "card_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "card": { | |
| "$ref": "#/components/schemas/card" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "carrier": { | |
| "description": "Partner that actually takes a shipment between places (ex: FedEx, DHL, SF Express)", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "tracking_url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "carrier_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "carrier_service": { | |
| "description": "Specific service rendered by the carrier (fedex ground saturday, ups overnight weekend, etc)", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "carrier": { | |
| "$ref": "#/components/schemas/carrier" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "cart_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_feed": { | |
| "description": "Describes a catalog feed.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "experience_feed_summaries": { | |
| "items": { | |
| "$ref": "#/components/schemas/experience_feed_summary" | |
| }, | |
| "type": "array" | |
| }, | |
| "incoming_feed": { | |
| "$ref": "#/components/schemas/incoming_feed" | |
| }, | |
| "outgoing_feed": { | |
| "$ref": "#/components/schemas/outgoing_feed" | |
| }, | |
| "feed_statistics_summary": { | |
| "$ref": "#/components/schemas/feed_statistics_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_feed_form_post": { | |
| "description": "Specify a catalog feed for one or more experiences.", | |
| "properties": { | |
| "experience_keys": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "incoming_feed": { | |
| "$ref": "#/components/schemas/incoming_feed" | |
| }, | |
| "outgoing_feed_form": { | |
| "$ref": "#/components/schemas/outgoing_feed" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_feed_form_put": { | |
| "description": "Specify a catalog feed for one or more experiences.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "experience_keys": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "incoming_feed": { | |
| "$ref": "#/components/schemas/incoming_feed" | |
| }, | |
| "outgoing_feed_form": { | |
| "$ref": "#/components/schemas/outgoing_feed" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_item_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_item_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/item" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_item_document": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "experiences": { | |
| "items": { | |
| "$ref": "#/components/schemas/experience_summary" | |
| }, | |
| "type": "array" | |
| }, | |
| "images": { | |
| "$ref": "#/components/schemas/catalog_item_document_images" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_item_document_images": { | |
| "properties": { | |
| "thumbnail": { | |
| "$ref": "#/components/schemas/image" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_item_export_type": { | |
| "description": "Defines the filters that can be applied when requesting a catalog item data export", | |
| "properties": { | |
| "numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "q": { | |
| "type": "string" | |
| }, | |
| "sort": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_item_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_item_summary": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_item_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "type": "string" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "price": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dimensions": { | |
| "type": "object" | |
| }, | |
| "images": { | |
| "items": { | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_item_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/item" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_statistics": { | |
| "description": "Statistics covering product catalog item information, including total catalog item count, number of distinct categories, etc.", | |
| "properties": { | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "categories": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "catalog_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "catalog": { | |
| "$ref": "#/components/schemas/catalog" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "category_summary": { | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "count": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "center": { | |
| "description": "Represents a facility capable of fulfilling a shipment", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "packaging": { | |
| "items": { | |
| "$ref": "#/components/schemas/packaging" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "services": { | |
| "items": { | |
| "$ref": "#/components/schemas/available_service" | |
| }, | |
| "type": "array" | |
| }, | |
| "schedule": { | |
| "$ref": "#/components/schemas/schedule" | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "capabilities": { | |
| "items": { | |
| "$ref": "#/components/schemas/center_capability" | |
| }, | |
| "type": "array" | |
| }, | |
| "partner_center": { | |
| "$ref": "#/components/schemas/partner_center" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "center_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/center" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "center_form": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "packaging": { | |
| "items": { | |
| "$ref": "#/components/schemas/packaging" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "services": { | |
| "items": { | |
| "$ref": "#/components/schemas/available_service" | |
| }, | |
| "type": "array" | |
| }, | |
| "schedule": { | |
| "$ref": "#/components/schemas/schedule" | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "capabilities": { | |
| "items": { | |
| "$ref": "#/components/schemas/center_capability" | |
| }, | |
| "type": "array" | |
| }, | |
| "partner_center_form": { | |
| "$ref": "#/components/schemas/partner_center_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "center_query": { | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "center_reference": { | |
| "properties": { | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "center_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "center_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "center_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/center" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "center_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/center" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_attribute": { | |
| "description": "A Checkout Attribute defines an attribute that will be made available via the checkout item content. This is useful if you would like to surface a specific attribute (like 'size' or 'color') in checkout.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_reference" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "attribute_keys": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_attribute_form": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| }, | |
| "attribute_keys": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_item_content": { | |
| "description": "A Checkout Item Content provides information about an item to support rendering of that item in the context of checkout", | |
| "properties": { | |
| "item": { | |
| "$ref": "#/components/schemas/item" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "items": { | |
| "$ref": "#/components/schemas/checkout_item_content_attribute" | |
| }, | |
| "type": "array" | |
| }, | |
| "image": { | |
| "$ref": "#/components/schemas/image" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_item_content_attribute": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_optin_responses": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "session_id": { | |
| "type": "string" | |
| }, | |
| "optin_responses": { | |
| "items": { | |
| "$ref": "#/components/schemas/optin_response" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_optin_responses_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_optin_responses_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "checkout_optin_responses": { | |
| "$ref": "#/components/schemas/checkout_optin_responses" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_token": { | |
| "description": "Represents a secure token that can be used to redirect to Checkout UI", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "$ref": "#/components/schemas/organization_reference" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/order_number_reference" | |
| }, | |
| "session": { | |
| "$ref": "#/components/schemas/session_reference" | |
| }, | |
| "urls": { | |
| "$ref": "#/components/schemas/checkout_urls" | |
| }, | |
| "expires_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_token_form": { | |
| "properties": { | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "session_id": { | |
| "type": "string" | |
| }, | |
| "urls": { | |
| "$ref": "#/components/schemas/checkout_urls_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_urls": { | |
| "properties": { | |
| "continue_shopping": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "checkout_urls_form": { | |
| "properties": { | |
| "continue_shopping": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "cleartext": { | |
| "description": "The actual value of the API token. This is modeled as a separate resource as it is fetched only on demand.", | |
| "properties": { | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "commercial_invoice_fee": { | |
| "properties": { | |
| "amount": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice": { | |
| "description": "The consumer invoice represents the details of a set of items from a given order. This may represent either the full order or a partial fulfillment.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/consumer_invoice_status" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/consumer_invoice_order_summary" | |
| }, | |
| "entity": { | |
| "$ref": "#/components/schemas/merchant_of_record_entity" | |
| }, | |
| "payments": { | |
| "items": { | |
| "$ref": "#/components/schemas/consumer_invoice_payment" | |
| }, | |
| "type": "array" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/consumer_invoice_center_reference" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| }, | |
| "billing_address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| }, | |
| "lines": { | |
| "items": { | |
| "$ref": "#/components/schemas/consumer_invoice_line" | |
| }, | |
| "type": "array" | |
| }, | |
| "documents": { | |
| "items": { | |
| "$ref": "#/components/schemas/consumer_invoice_document" | |
| }, | |
| "type": "array" | |
| }, | |
| "tax_registration": { | |
| "$ref": "#/components/schemas/tax_registration" | |
| }, | |
| "customer_type": { | |
| "$ref": "#/components/schemas/consumer_invoice_customer_type" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_center_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "$ref": "#/components/schemas/address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "consumer_invoice": { | |
| "$ref": "#/components/schemas/consumer_invoice" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_document": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/consumer_invoice_document_type" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_form": { | |
| "properties": { | |
| "order_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_form_by_order": { | |
| "properties": {}, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_levy": { | |
| "properties": { | |
| "rate": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "value": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_levy_form": { | |
| "properties": { | |
| "rate": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_line_discount": { | |
| "properties": { | |
| "price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "tax": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_line_discount_form": { | |
| "properties": { | |
| "price": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "tax": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy_form" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_line_item": { | |
| "properties": { | |
| "item": { | |
| "$ref": "#/components/schemas/item_reference" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "unit_price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "unit_discount": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "unit_tax": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy" | |
| }, | |
| "unit_duty": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_line_item_form": { | |
| "properties": { | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "unit_price": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "unit_tax": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy_form" | |
| }, | |
| "unit_duty": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_line_shipping": { | |
| "properties": { | |
| "price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "tax": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_line_shipping_form": { | |
| "properties": { | |
| "price": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "tax": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy_form" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/consumer_invoice_levy_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_order_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "submitted_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_payment": { | |
| "properties": { | |
| "date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "billing_address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "consumer_invoice_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "consumer_invoice": { | |
| "$ref": "#/components/schemas/consumer_invoice" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "contact": { | |
| "description": "Defines structured fields for a contact person. Typically used for specifying contact person for an account, shipment, or organization representative", | |
| "properties": { | |
| "name": { | |
| "$ref": "#/components/schemas/name" | |
| }, | |
| "company": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "country": { | |
| "description": "ISO 3166 country codes. Note Flow APIs will accept either the 2 or 3 character country code, but internally we normalize data and store as the 3 character, upper case ISO code. See https://api.flow.io/reference/countries", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "iso_3166_2": { | |
| "type": "string" | |
| }, | |
| "iso_3166_3": { | |
| "type": "string" | |
| }, | |
| "languages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "measurement_system": { | |
| "type": "string" | |
| }, | |
| "default_currency": { | |
| "type": "string" | |
| }, | |
| "default_language": { | |
| "type": "string" | |
| }, | |
| "timezones": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "default_delivered_duty": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "country_availability": { | |
| "properties": { | |
| "status": { | |
| "$ref": "#/components/schemas/item_availability_status" | |
| }, | |
| "countries": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "country_defaults": { | |
| "description": "Provides country level default settings for currency, language, etc.", | |
| "properties": { | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "credit_memo": { | |
| "description": "The credit memo represents the details of a refund and the reasons for the issuance of the refund.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/consumer_invoice_status" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "invoice": { | |
| "$ref": "#/components/schemas/consumer_invoice_reference" | |
| }, | |
| "entity": { | |
| "$ref": "#/components/schemas/merchant_of_record_entity" | |
| }, | |
| "payments": { | |
| "items": { | |
| "$ref": "#/components/schemas/consumer_invoice_payment" | |
| }, | |
| "type": "array" | |
| }, | |
| "lines": { | |
| "items": { | |
| "$ref": "#/components/schemas/consumer_invoice_line" | |
| }, | |
| "type": "array" | |
| }, | |
| "documents": { | |
| "items": { | |
| "$ref": "#/components/schemas/consumer_invoice_document" | |
| }, | |
| "type": "array" | |
| }, | |
| "tax_registration": { | |
| "$ref": "#/components/schemas/tax_registration" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "credit_memo_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "credit_memo": { | |
| "$ref": "#/components/schemas/credit_memo" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "credit_memo_form": { | |
| "description": "A credit memo form defines the information needed to create a credit memo. You must provide a way to identify the refund issued - either by id, key or identifier.", | |
| "properties": { | |
| "refund_id": { | |
| "type": "string" | |
| }, | |
| "refund_key": { | |
| "type": "string" | |
| }, | |
| "refund_identifier": { | |
| "type": "string" | |
| }, | |
| "lines": { | |
| "items": { | |
| "$ref": "#/components/schemas/consumer_invoice_line_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "credit_memo_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "credit_memo": { | |
| "$ref": "#/components/schemas/credit_memo" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "credit_payment": { | |
| "description": "A Credit Payment records a 'non cash' payment against an order (e.g. a store credit, gift card, etc.), recording the amount of that credit and additional details to reconcile payments. The primary purpose of the credit payment is to record that a payment has been made against an order so the remaining balance can be correctly computed.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/expandable_order" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "original": { | |
| "$ref": "#/components/schemas/original_prices" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "credit_payment_error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/credit_payment_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "codes": { | |
| "items": { | |
| "$ref": "#/components/schemas/credit_payment_error_code" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "credit_payment_form": { | |
| "properties": { | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "max": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "credit_payment_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "credit_payment": { | |
| "$ref": "#/components/schemas/credit_payment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "crossdock_shipment": { | |
| "properties": { | |
| "partner_id": { | |
| "type": "string" | |
| }, | |
| "center_id": { | |
| "type": "string" | |
| }, | |
| "tracking_id": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "crossdock_shipment_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "crossdock_shipment": { | |
| "$ref": "#/components/schemas/crossdock_shipment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "currency": { | |
| "description": "ISO 4217 3-character currency code. See https://api.flow.io/reference/currencies", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "iso_4217_3": { | |
| "type": "string" | |
| }, | |
| "number_decimals": { | |
| "type": "integer" | |
| }, | |
| "symbols": { | |
| "$ref": "#/components/schemas/currency_symbols" | |
| }, | |
| "default_locale": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "currency_format": { | |
| "properties": { | |
| "symbol": { | |
| "$ref": "#/components/schemas/currency_symbol_format" | |
| }, | |
| "label_formatters": { | |
| "items": { | |
| "$ref": "#/components/schemas/currency_label_formatter" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "currency_format_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "currency_format_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| }, | |
| "symbol": { | |
| "$ref": "#/components/schemas/currency_symbol_format" | |
| }, | |
| "label_formatters": { | |
| "items": { | |
| "$ref": "#/components/schemas/currency_label_formatter" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "currency_symbols": { | |
| "description": "Defines one or more symbols representing this currency", | |
| "properties": { | |
| "primary": { | |
| "type": "string" | |
| }, | |
| "narrow": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "customer": { | |
| "description": "A customer represents the actual person purchasing from you. This information is needed primarily to support logistics (delivery to this person), fraud management (verification of who the person is), and reporting. We also recommend including your customer number whenever possible as doing so will allow Flow to link up transactions for this customer making customer service easier.", | |
| "properties": { | |
| "name": { | |
| "$ref": "#/components/schemas/name" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "cvv": { | |
| "description": "Represents the card verification results", | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/cvv_code" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "datetime_range": { | |
| "properties": { | |
| "from": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "to": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivered_duty_setting": { | |
| "properties": { | |
| "default": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "available": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "type": "array" | |
| }, | |
| "display": { | |
| "$ref": "#/components/schemas/delivered_duty_display_type" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_item": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "shipment_estimate": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/money_with_optional_base" | |
| }, | |
| "center": { | |
| "type": "string" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/money_with_optional_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_option": { | |
| "description": "Represents a way to fulfill a delivery, including an estimates for the date range and cost", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "cost": { | |
| "$ref": "#/components/schemas/price_with_base_and_details" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price_with_base_and_details" | |
| }, | |
| "service": { | |
| "$ref": "#/components/schemas/service_summary" | |
| }, | |
| "tier": { | |
| "$ref": "#/components/schemas/tier_summary" | |
| }, | |
| "window": { | |
| "$ref": "#/components/schemas/delivery_window" | |
| }, | |
| "rule_outcome": { | |
| "$ref": "#/components/schemas/tier_rule_outcome" | |
| }, | |
| "weight": { | |
| "$ref": "#/components/schemas/option_weight_estimates" | |
| }, | |
| "send_to": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "surcharge": { | |
| "$ref": "#/components/schemas/price_with_base_and_details" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_option_cost_component": { | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/delivery_option_cost_detail_component_key" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_option_cost_detail": { | |
| "properties": { | |
| "source": { | |
| "$ref": "#/components/schemas/delivery_option_cost_detail_source" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "components": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery_option_cost_component" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_option_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_option_form": { | |
| "description": "Represents a way to fulfill a delivery, including an estimates for the date range and cost", | |
| "properties": { | |
| "delivery": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/line_item_form" | |
| }, | |
| "type": "array" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_option_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_option_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "cost": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "service": { | |
| "$ref": "#/components/schemas/service_reference" | |
| }, | |
| "tier": { | |
| "$ref": "#/components/schemas/tier_reference" | |
| }, | |
| "window": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_option_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "cost": { | |
| "type": "object" | |
| }, | |
| "price": { | |
| "type": "object" | |
| }, | |
| "delivered_duty": { | |
| "type": "string" | |
| }, | |
| "service_id": { | |
| "type": "string" | |
| }, | |
| "tier": { | |
| "type": "object" | |
| }, | |
| "window": { | |
| "type": "object" | |
| }, | |
| "rule_outcome": { | |
| "type": "object" | |
| }, | |
| "weight": { | |
| "type": "object" | |
| }, | |
| "delivery_window_components": { | |
| "type": "object" | |
| }, | |
| "surcharge": { | |
| "$ref": "#/components/schemas/price_with_base_and_details" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_option_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "delivery_option": { | |
| "$ref": "#/components/schemas/delivery_option_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/line_item_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "delivery": { | |
| "$ref": "#/components/schemas/delivery_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_window": { | |
| "description": "Flow's estimate of when a shipment for this delivery will actually arrive at the final destination, taking into account a shipment estimate, center schedules, and carrier transit windows.", | |
| "properties": { | |
| "from": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "to": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "label": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_window_component": { | |
| "properties": { | |
| "from": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "to": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/delivery_window_component_source" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_window_components": { | |
| "description": "Components and information taken into account when calculating a final delivery window.", | |
| "properties": { | |
| "shipment_estimate": { | |
| "$ref": "#/components/schemas/delivery_window_component" | |
| }, | |
| "transit_estimate": { | |
| "$ref": "#/components/schemas/delivery_window_component" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "delivery_window_components_v2": { | |
| "description": "Components and information taken into account when calculating a final delivery window", | |
| "properties": { | |
| "processing_estimates": { | |
| "items": { | |
| "$ref": "#/components/schemas/processing_estimate" | |
| }, | |
| "type": "array" | |
| }, | |
| "transit_estimates": { | |
| "items": { | |
| "$ref": "#/components/schemas/transit_estimate" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "deminimis_per_item": { | |
| "description": "De Minimis per item describes rules which require minimum and/or maximum values per item", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "minimum": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "maximum": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "deminimis_simple": { | |
| "description": "De Minimis for most common example which includes a value threshold and rules on what components are used in the duty calculation", | |
| "properties": { | |
| "value": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "components": { | |
| "items": { | |
| "$ref": "#/components/schemas/levy_component" | |
| }, | |
| "type": "array" | |
| }, | |
| "minimum": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "detailed_shipping_label_form": { | |
| "properties": { | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "origin": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "package": { | |
| "$ref": "#/components/schemas/shipping_label_package" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "direction": { | |
| "$ref": "#/components/schemas/direction" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| }, | |
| "shipment_recipient": { | |
| "$ref": "#/components/schemas/shipment_recipient" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "detailed_shipping_notification_form": { | |
| "description": "Detailed form for information about a client-facilitated shipment where the shipping label and fulfillment was not handled by Flow.", | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "package": { | |
| "$ref": "#/components/schemas/shipping_label_package" | |
| }, | |
| "service": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "shipment_recipient": { | |
| "$ref": "#/components/schemas/shipment_recipient" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "digital_delivery": { | |
| "description": "Represents a collection of items that are digitally available and do not require a physical shipment", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery_item" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "dimension": { | |
| "properties": { | |
| "depth": { | |
| "$ref": "#/components/schemas/measurement" | |
| }, | |
| "diameter": { | |
| "$ref": "#/components/schemas/measurement" | |
| }, | |
| "length": { | |
| "$ref": "#/components/schemas/measurement" | |
| }, | |
| "weight": { | |
| "$ref": "#/components/schemas/measurement" | |
| }, | |
| "width": { | |
| "$ref": "#/components/schemas/measurement" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "dimensions": { | |
| "properties": { | |
| "product": { | |
| "$ref": "#/components/schemas/dimension" | |
| }, | |
| "packaging": { | |
| "$ref": "#/components/schemas/dimension" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "direct_authorization_form": { | |
| "description": "Creates an authorization for a transaction in which you remain the merchant of record. An authorization is used to check and reserve funds w/ a given payment method. No funds are actually transferred; once you have you an authorization, you can capture up to the amount of the authorization.", | |
| "properties": { | |
| "token": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "customer": { | |
| "$ref": "#/components/schemas/customer" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "cvv": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "billing_address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "options": { | |
| "items": { | |
| "$ref": "#/components/schemas/authorization_option" | |
| }, | |
| "type": "array" | |
| }, | |
| "redirect_urls": { | |
| "$ref": "#/components/schemas/post_payment_redirect_urls" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "direct_debit": { | |
| "description": "Represents an online direct debit payment.", | |
| "properties": { | |
| "routing_number": { | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "discount": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "type": "string" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "duration": { | |
| "description": "Represents a duration of time.", | |
| "properties": { | |
| "unit": { | |
| "$ref": "#/components/schemas/unit_of_time" | |
| }, | |
| "value": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "duty": { | |
| "description": "Represents a simple model of duties that apply to a given item / trade lane.", | |
| "properties": { | |
| "rate": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "components": { | |
| "items": { | |
| "$ref": "#/components/schemas/levy_component" | |
| }, | |
| "type": "array" | |
| }, | |
| "deminimis": { | |
| "$ref": "#/components/schemas/deminimis" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "email_verification": { | |
| "description": "Represents the successful response of an email verification token. We return the email address in this case to allow the UI to display which email address was verified.", | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "estimated_window": { | |
| "description": "Range of time given a from and to number and the unit. For example: 1-4 hours or 4-7 days", | |
| "properties": { | |
| "from": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "to": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "unit": { | |
| "$ref": "#/components/schemas/unit_of_time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "exception": { | |
| "description": "Represents an exception to the schedule of a center.", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/exception_type" | |
| }, | |
| "datetime_range": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience": { | |
| "description": "Experiences define a local experience for a given geographic region", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "region": { | |
| "$ref": "#/components/schemas/region_reference" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "measurement_system": { | |
| "$ref": "#/components/schemas/measurement_system" | |
| }, | |
| "subcatalog": { | |
| "$ref": "#/components/schemas/subcatalog_reference" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "settings": { | |
| "$ref": "#/components/schemas/experience_settings" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/experience_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_currency_format": { | |
| "properties": { | |
| "symbol": { | |
| "$ref": "#/components/schemas/currency_symbol_format" | |
| }, | |
| "label_formatters": { | |
| "items": { | |
| "$ref": "#/components/schemas/currency_label_formatter" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_currency_format_form": { | |
| "properties": { | |
| "symbol": { | |
| "$ref": "#/components/schemas/currency_symbol_format" | |
| }, | |
| "label_formatters": { | |
| "items": { | |
| "$ref": "#/components/schemas/currency_label_formatter" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_defaults": { | |
| "description": "Defines a set of defaults for a given organization and region", | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "measurement_system": { | |
| "$ref": "#/components/schemas/measurement_system" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "subcatalog_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_feed_summary": { | |
| "properties": { | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_reference" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "last_construct_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_form": { | |
| "description": "Experiences define a local experience for a given geographic region", | |
| "properties": { | |
| "region_id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "measurement_system": { | |
| "$ref": "#/components/schemas/measurement_system" | |
| }, | |
| "subcatalog_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_geo": { | |
| "description": "Experience Geo summarizes an experience along with geographic info", | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "region": { | |
| "$ref": "#/components/schemas/region_reference" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "measurement_system": { | |
| "$ref": "#/components/schemas/measurement_system" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_logistics_settings": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_overview" | |
| }, | |
| "shipping_configuration": { | |
| "$ref": "#/components/schemas/shipping_configuration_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_logistics_settings_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "logistics_settings": { | |
| "$ref": "#/components/schemas/experience_logistics_settings" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_logistics_settings_put_form": { | |
| "description": "Assigns logistics related settings to an experience", | |
| "properties": { | |
| "shipping_configuration_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_logistics_settings_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "logistics_settings": { | |
| "$ref": "#/components/schemas/experience_logistics_settings" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_logistics_summary": { | |
| "properties": { | |
| "outbound": { | |
| "$ref": "#/components/schemas/experience_logistics_tier_summary" | |
| }, | |
| "return": { | |
| "$ref": "#/components/schemas/experience_logistics_tier_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_logistics_tier_summary": { | |
| "properties": { | |
| "prices": { | |
| "$ref": "#/components/schemas/experience_logistics_tier_summary_prices" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_logistics_tier_summary_prices": { | |
| "properties": { | |
| "minimum": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_overview": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_payment_method_rule_form": { | |
| "properties": { | |
| "payment_method_id": { | |
| "type": "string" | |
| }, | |
| "tags": { | |
| "items": { | |
| "$ref": "#/components/schemas/experience_payment_method_tag" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_price_book_mapping": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_reference" | |
| }, | |
| "price_book": { | |
| "$ref": "#/components/schemas/price_book_reference" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_price_book_mapping_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_price_book_mapping_form": { | |
| "properties": { | |
| "price_book_key": { | |
| "type": "string" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_price_book_mapping_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "experience_price_book_mapping": { | |
| "$ref": "#/components/schemas/experience_price_book_mapping" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_reference": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_settings": { | |
| "properties": { | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty_setting" | |
| }, | |
| "pricing_settings": { | |
| "$ref": "#/components/schemas/pricing_settings" | |
| }, | |
| "logistics_settings": { | |
| "$ref": "#/components/schemas/logistics_settings" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_status_form": { | |
| "description": "The experience status form is used to update the status of a particular experience.", | |
| "properties": { | |
| "status": { | |
| "$ref": "#/components/schemas/experience_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_summary": { | |
| "description": "Some important fields related to experiences used in various APIs", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "delivered_duty": { | |
| "type": "string" | |
| }, | |
| "subcatalog_id": { | |
| "type": "string" | |
| }, | |
| "region_id": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "measurement_system": { | |
| "type": "string" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "status": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "experience_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "expiration": { | |
| "description": "The month and year at which a card expires", | |
| "properties": { | |
| "month": { | |
| "type": "integer" | |
| }, | |
| "year": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "export": { | |
| "description": "Exports represent data extraction requests (e.g. download my catalog items to a CSV file)", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/export_type" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/export_status" | |
| }, | |
| "organization_q": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "completed_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "deliveries": { | |
| "items": { | |
| "$ref": "#/components/schemas/export_delivery" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "export_delivery_email": { | |
| "description": "Triggers an email notification once the requested export is ready", | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "export_form": { | |
| "description": "Export forms are used to create exports. The export type defines both the type of the export (e.g. the CSV File format) and the available parameters for each export (e.g. the filters to apply to select the desired data).", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/export_type" | |
| }, | |
| "emails": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "organization_q": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "export_localized_item_prices": { | |
| "properties": { | |
| "organization": { | |
| "$ref": "#/components/schemas/organization_reference" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_reference" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/catalog_item_reference" | |
| }, | |
| "prices": { | |
| "$ref": "#/components/schemas/export_localized_item_prices_detail" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/subcatalog_item_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "export_localized_item_prices_detail": { | |
| "properties": { | |
| "item": { | |
| "$ref": "#/components/schemas/localized_item_price" | |
| }, | |
| "vat": { | |
| "$ref": "#/components/schemas/localized_item_vat" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/localized_item_duty" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "export_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "export": { | |
| "$ref": "#/components/schemas/export" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "external_api_timeout_reservation_error": { | |
| "properties": { | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "feed_statistics_summary": { | |
| "description": "A brief packet of statistics about a live feed. Will be blank for most new feeds.", | |
| "properties": { | |
| "last_incoming_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "flat_rate": { | |
| "description": "Rule outcome where shipping surfaced in quote is pre-defined flat rate", | |
| "properties": { | |
| "price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "zero_amount_indicator": { | |
| "$ref": "#/components/schemas/zero_amount_indicator" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "flat_rate_form": { | |
| "properties": { | |
| "price": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "zero_amount_indicator": { | |
| "$ref": "#/components/schemas/zero_amount_indicator" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "flow_center_reference": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "flow_item_index_metadata": { | |
| "properties": { | |
| "status": { | |
| "$ref": "#/components/schemas/subcatalog_item_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fraud_email_rule": { | |
| "description": "White and black listing", | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "decision": { | |
| "$ref": "#/components/schemas/fraud_email_rule_decision" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fraud_email_rule_form": { | |
| "properties": { | |
| "rule": { | |
| "$ref": "#/components/schemas/fraud_email_rule" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fraud_status_changed": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/order_reference" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/fraud_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "free_shipping": { | |
| "properties": { | |
| "trigger": { | |
| "$ref": "#/components/schemas/promotion_trigger" | |
| }, | |
| "max": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "free_shipping_order_promotion": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/expandable_order" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "trigger": { | |
| "$ref": "#/components/schemas/order_promotion_trigger" | |
| }, | |
| "max": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "free_shipping_order_promotion_form": { | |
| "properties": { | |
| "trigger": { | |
| "$ref": "#/components/schemas/promotion_trigger_form" | |
| }, | |
| "max": { | |
| "$ref": "#/components/schemas/price_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ftp_account": { | |
| "description": "The FTP Account is your username and password to access this FTP server.", | |
| "properties": { | |
| "server": { | |
| "$ref": "#/components/schemas/ftp_server" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/ftp_user" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ftp_file": { | |
| "description": "The FTP File represents a file uploaded to the FTP Server", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/ftp_file_source" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "directory": { | |
| "type": "string" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ftp_file_form": { | |
| "description": "Create a file that will be uploaded to this organization's FTP Server", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "directory": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ftp_folder": { | |
| "description": "The FTP Folder represents a single folder associated with an organization for which we create an external FTP Directory", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "path": { | |
| "type": "string" | |
| }, | |
| "webhook": { | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ftp_folder_form": { | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "webhook": { | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ftp_organization_settings": { | |
| "description": "The FTP Organization Settings allows you to enable an FTP Drop Point for an organization, creating the standard set of FTP Folders, credentials, and associated webhooks.", | |
| "properties": { | |
| "enabled": { | |
| "type": "boolean" | |
| }, | |
| "emails": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "account": { | |
| "$ref": "#/components/schemas/ftp_account" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ftp_organization_settings_form": { | |
| "properties": { | |
| "enabled": { | |
| "type": "boolean" | |
| }, | |
| "emails": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ftp_server": { | |
| "properties": { | |
| "hostname": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ftp_user": { | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fulfillment": { | |
| "description": "Used to track and manage the fulfillment of an order.", | |
| "properties": { | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/fulfillment_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/center_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fulfillment_cancellation_form": { | |
| "description": "Changing an order for the purpose of cancelling specific line quantities", | |
| "properties": { | |
| "change_source": { | |
| "$ref": "#/components/schemas/order_change_source" | |
| }, | |
| "reason": { | |
| "$ref": "#/components/schemas/cancel_reason" | |
| }, | |
| "lines": { | |
| "items": { | |
| "$ref": "#/components/schemas/fulfillment_line_cancel_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fulfillment_complete_cancellation_form": { | |
| "description": "Changing an order for the purpose of completely cancelling all remaining uncancelled, unshipped lines of an order.", | |
| "properties": { | |
| "change_source": { | |
| "$ref": "#/components/schemas/order_change_source" | |
| }, | |
| "reason": { | |
| "$ref": "#/components/schemas/cancel_reason" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fulfillment_experience_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fulfillment_item": { | |
| "description": "Used to track and manage the fulfillment of quantities of a sku", | |
| "properties": { | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "line_number": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "quantities": { | |
| "items": { | |
| "$ref": "#/components/schemas/fulfillment_item_quantity" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fulfillment_item_allocation_details": { | |
| "description": "Details about how prices were allocated to a fulfillment; use for reporting the value or net value of a line", | |
| "properties": { | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "line_number": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "levies": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fulfillment_item_quantity": { | |
| "description": "Fulfillment status of item quantities", | |
| "properties": { | |
| "status": { | |
| "$ref": "#/components/schemas/fulfillment_item_quantity_status" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fulfillment_line_cancel_form": { | |
| "description": "At least one of item_number, line_number are required. If you can, send both.", | |
| "properties": { | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "line_number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "fully_harmonized_item_upserted": { | |
| "description": "Event indicating insertion or changes to the details of a fully harmonized item. Will be triggered upon any change to the item being harmonized, its duties or taxes. If two changes occur within minutes of each other, it is possible only one upserted event will be produced, aggregating both changes.", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "customs_description": { | |
| "type": "string" | |
| }, | |
| "hs6_code": { | |
| "type": "string" | |
| }, | |
| "landed_costs": { | |
| "items": { | |
| "$ref": "#/components/schemas/lane_landed_cost" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "generic_error": { | |
| "description": "An error of some type has occurred. The most common error will be validation on input. See messages for details.", | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/generic_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "generic_reservation_error": { | |
| "properties": { | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "geo_form": { | |
| "description": "Form used to update geographic preferences", | |
| "properties": { | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "google_pay_authorization_payload": { | |
| "properties": { | |
| "payload": { | |
| "type": "object" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonization_document": { | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "items": { | |
| "$ref": "#/components/schemas/category_summary" | |
| }, | |
| "type": "array" | |
| }, | |
| "origin": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonization_hs10_export_type": { | |
| "description": "Exports harmonization HS10 codes", | |
| "properties": { | |
| "origin": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| }, | |
| "numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_codes": { | |
| "type": "boolean" | |
| }, | |
| "has_origins": { | |
| "type": "boolean" | |
| }, | |
| "sort": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonization_hs6_export_type": { | |
| "description": "Exports HS6 codes", | |
| "properties": { | |
| "numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_codes": { | |
| "type": "boolean" | |
| }, | |
| "sort": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonization_overview_export_type": { | |
| "description": "Exports HS10 code overview details", | |
| "properties": { | |
| "origin": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| }, | |
| "sort": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonization_settings": { | |
| "description": "Organization level settings.", | |
| "properties": { | |
| "duty_strategy": { | |
| "$ref": "#/components/schemas/levy_strategy" | |
| }, | |
| "tax_strategy": { | |
| "$ref": "#/components/schemas/levy_strategy" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonization_settings_form": { | |
| "properties": { | |
| "duty_strategy": { | |
| "$ref": "#/components/schemas/levy_strategy" | |
| }, | |
| "tax_strategy": { | |
| "$ref": "#/components/schemas/levy_strategy" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_category": { | |
| "description": "Categories optimized for harmonization", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "parent": { | |
| "$ref": "#/components/schemas/harmonized_category_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_category_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item": { | |
| "description": "A harmonized item stores explicit information about this item for the purposes of harmonization / classification. The harmonization process begins by creating a harmonized item; this kicks off the internal processes. Once assigned, codes will be available via the hs6 and hs10 resources", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item_duty": { | |
| "description": "Used to specifically set an item's duty rate for a given trade lane.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/harmonized_item_reference" | |
| }, | |
| "origin": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| }, | |
| "rate": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item_duty_form": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| }, | |
| "rate": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item_duty_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "harmonized_item_duty": { | |
| "$ref": "#/components/schemas/harmonized_item_duty" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item_form": { | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item_put_form": { | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_item_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "harmonized_item": { | |
| "$ref": "#/components/schemas/harmonized_item" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_landed_cost": { | |
| "description": "Summary of landed cost data (taxes and duties) for 1 or more items going to a single destination country. Records are unique based on (item.number, country of origin).", | |
| "properties": { | |
| "address": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/harmonized_landed_cost_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "tax_registration": { | |
| "$ref": "#/components/schemas/tax_registration" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_landed_cost_form": { | |
| "description": "Allows calculation of duty and tax for multiple items in one API call for items going to a specific destination country", | |
| "properties": { | |
| "address": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "item_numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "source_address": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "line_items": { | |
| "items": { | |
| "$ref": "#/components/schemas/line_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "tax_registration_id": { | |
| "type": "string" | |
| }, | |
| "billing_address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_landed_cost_item": { | |
| "description": "Duty and tax information for a given item. Note that the internal implementation supports multiple countries of origin.", | |
| "properties": { | |
| "item": { | |
| "$ref": "#/components/schemas/harmonized_item_reference" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/duty" | |
| }, | |
| "tax": { | |
| "$ref": "#/components/schemas/tax" | |
| }, | |
| "tax_applicability": { | |
| "$ref": "#/components/schemas/tax_applicability" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "harmonized_landed_cost_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "landed_cost": { | |
| "$ref": "#/components/schemas/harmonized_landed_cost" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "header": { | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "healthcheck": { | |
| "properties": { | |
| "status": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hint_result": { | |
| "description": "Result of looking up a code using a hint.", | |
| "properties": { | |
| "tariff_code": { | |
| "$ref": "#/components/schemas/tariff_code" | |
| }, | |
| "likelihood": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hs10": { | |
| "description": "The (Harmonized System) HS-10 code assigned to an item with a given origin/destination pair.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/harmonized_item_reference" | |
| }, | |
| "origin": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hs10_code_deleted": { | |
| "description": "Event raised whenever an HS-10 code is unassigned from an item", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hs10_code_upserted": { | |
| "description": "Event raised whenever an HS-10 code is assigned to an item", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hs10_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "hs10": { | |
| "$ref": "#/components/schemas/hs10" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hs6": { | |
| "description": "The (Harmonized System) HS-6 code assigned to an item.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/harmonized_item_reference" | |
| }, | |
| "code": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hs6_code_deleted": { | |
| "description": "Event raised whenever an HS-6 code is deleted", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hs6_code_upserted": { | |
| "description": "Event raised whenever an HS-6 code is assigned to an item", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hs6_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "hs6": { | |
| "$ref": "#/components/schemas/hs6" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "hs_code": { | |
| "description": "Harmonized System codes, up to 6 digits (HS-6). These codes should be the same for all countries.", | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "parent": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "identifier_form": { | |
| "properties": { | |
| "primary": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "image": { | |
| "description": "The URL to an image, with optional tags. Flow Commerce primarily uses images to enhance the administrative tools (e.g. showing an item image in console)", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "tags": { | |
| "items": { | |
| "$ref": "#/components/schemas/image_tag" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "image_form": { | |
| "description": "Image form defines the data needed to create an image", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "tags": { | |
| "items": { | |
| "$ref": "#/components/schemas/image_tag" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "import": { | |
| "description": "Imports allow you to upload data to Flow via files in batch. Each import fetches data from a given URL. The type of the import determines which file format to expect and what data to update", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/import_type" | |
| }, | |
| "source_url": { | |
| "type": "string" | |
| }, | |
| "filename": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/export_status" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "completed_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "results": { | |
| "$ref": "#/components/schemas/import_results" | |
| }, | |
| "deliveries": { | |
| "items": { | |
| "$ref": "#/components/schemas/export_delivery" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "import_form": { | |
| "description": "Import forms create imports. The import type defines both the type of the import (e.g. the CSV File format) and the URL at which the source data are available. If you do not have a URL readily available, you can first upload a file via the Flow API - see the resource named 'Upload'", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/import_type" | |
| }, | |
| "source_url": { | |
| "type": "string" | |
| }, | |
| "filename": { | |
| "type": "string" | |
| }, | |
| "emails": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "import_results": { | |
| "properties": { | |
| "number_successful": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "number_errors": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "import_template": { | |
| "description": "An import template provides an organization specific example CSV file of a particular import type.", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/import_type" | |
| }, | |
| "documentation_url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "import_template_example": { | |
| "description": "An import template example provides a link to a real, organization specific example CSV import file.", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "import_template_form": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/import_type" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "import_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "import": { | |
| "$ref": "#/components/schemas/import" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inbound_carton_fee": { | |
| "properties": { | |
| "amount": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "included_levies": { | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/included_levy_key" | |
| }, | |
| "label": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "incoming_feed": { | |
| "description": "Describe a feed incoming to Flow", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "format": { | |
| "$ref": "#/components/schemas/incoming_feed_format" | |
| }, | |
| "minute": { | |
| "type": "integer" | |
| }, | |
| "item_link": { | |
| "$ref": "#/components/schemas/item_link" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inline_authorization_details": { | |
| "description": "Represents an online payment that requires the client token from underlying payment processor before entering their payment information.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "client_token": { | |
| "type": "string" | |
| }, | |
| "parameters": { | |
| "type": "object" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inline_authorization_form": { | |
| "description": "Executes a widget-based payment based on the provided payment method.", | |
| "properties": { | |
| "method": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "$ref": "#/components/schemas/issuer_reference" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "billing_address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "payload": { | |
| "$ref": "#/components/schemas/authorization_payload" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "input_form": { | |
| "properties": {}, | |
| "type": "object" | |
| }, | |
| "input_form_specification": { | |
| "properties": { | |
| "inputs": { | |
| "items": { | |
| "$ref": "#/components/schemas/input_specification" | |
| }, | |
| "type": "array" | |
| }, | |
| "limitations": { | |
| "$ref": "#/components/schemas/input_specification_limitations" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "input_specification": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/input_specification_type" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "display_text": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "input_specification_limitation_max": { | |
| "description": "Represents the maximum number of accepted inputs", | |
| "properties": { | |
| "max": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "input_specification_limitations": { | |
| "properties": { | |
| "limitations": { | |
| "items": { | |
| "$ref": "#/components/schemas/input_specification_limitation" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "installment_plan_payment_error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/installment_plan_payment_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "codes": { | |
| "items": { | |
| "$ref": "#/components/schemas/installment_plan_payment_error_code" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "installment_plan_payment_form": { | |
| "description": "The installment payment form is used to create an installment plan for an order, associating the plan immediately with this order.", | |
| "properties": { | |
| "installment_program_id": { | |
| "type": "string" | |
| }, | |
| "authorization_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "installment_program_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "initial": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_backorder": { | |
| "description": "Enables backorders, setting an optional number of units that we allow for backorder. For example, a backorder w/ quantity 10 will enable selling until the actual inventory quantity is -10.", | |
| "properties": { | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_center_reference": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_check_response": { | |
| "properties": { | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/inventory_check_response_item" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_check_response_item": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "inventory_status": { | |
| "$ref": "#/components/schemas/inventory_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_experience_reference": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_item_reference": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_request": { | |
| "properties": { | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/inventory_request_item" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_request_item": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_rule": { | |
| "description": "Ordered list of rules to apply, from first to last, to get available quantity. This is unique per organization", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "query": { | |
| "type": "string" | |
| }, | |
| "strategy": { | |
| "$ref": "#/components/schemas/inventory_strategy" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_rule_form": { | |
| "properties": { | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "query": { | |
| "type": "string" | |
| }, | |
| "strategy": { | |
| "$ref": "#/components/schemas/inventory_strategy" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_rule_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "inventory_rule": { | |
| "$ref": "#/components/schemas/inventory_rule" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_snapshot": { | |
| "description": "Inventory snapshot reflects the current quantity and available number of units for a given center / item", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "available": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/inventory_center_reference" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/inventory_item_reference" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_snapshot_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "inventory_snapshot": { | |
| "$ref": "#/components/schemas/inventory_snapshot" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_stock": { | |
| "description": "Treats inventory as available as long as the actual inventory quantity is > the specified quantity. A common use case is to set quantity to zero to indicate availability as long as there is at least 1 unit available.", | |
| "properties": { | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_unlimited": { | |
| "description": "Items affected with rules pursuing an unlimited strategy will always be available", | |
| "properties": { | |
| "quantity": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_update": { | |
| "description": "Represents a single update on inventory quantity", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "idempotency_key": { | |
| "type": "string" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/inventory_center_reference" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/inventory_item_reference" | |
| }, | |
| "notes": { | |
| "type": "object" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/update_type" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_update_form": { | |
| "description": "Form used to create an update on inventory. If inventory for center/item has not been previously created, a new row is created for the center/item tuple.", | |
| "properties": { | |
| "center": { | |
| "type": "string" | |
| }, | |
| "idempotency_key": { | |
| "type": "string" | |
| }, | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/update_type" | |
| }, | |
| "notes": { | |
| "type": "object" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inventory_update_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "inventory_update": { | |
| "$ref": "#/components/schemas/inventory_update" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "invitation": { | |
| "description": "An invitation via email to a user to join this organization. The user will then walk through a user login/registration process and will immediately become a member of the organization.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "$ref": "#/components/schemas/expandable_organization" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "$ref": "#/components/schemas/name" | |
| }, | |
| "role": { | |
| "$ref": "#/components/schemas/role" | |
| }, | |
| "roles": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_role" | |
| }, | |
| "type": "array" | |
| }, | |
| "expiration": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "invitation_error": { | |
| "description": "Returns information as to why a particular invitation could not be accepted.", | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/invitation_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "invitation_form": { | |
| "properties": { | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "$ref": "#/components/schemas/name" | |
| }, | |
| "role": { | |
| "$ref": "#/components/schemas/role" | |
| }, | |
| "roles": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_role" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "invitation_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "invitation": { | |
| "$ref": "#/components/schemas/invitation" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "invoice_export": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "invoice_export_form": { | |
| "properties": { | |
| "date_from": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "date_to": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "issuer_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "issuer_summary": { | |
| "properties": { | |
| "iin": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "issuer_v1": { | |
| "properties": { | |
| "iin": { | |
| "type": "string" | |
| }, | |
| "card_brand": { | |
| "type": "string" | |
| }, | |
| "card_type": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| } | |
| }, | |
| "deprecated": true, | |
| "type": "object" | |
| }, | |
| "item": { | |
| "description": "The Flow item defines a specific item that can be purchased by a consumer. For many clients, this will map to a Sku.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dimensions": { | |
| "$ref": "#/components/schemas/dimensions" | |
| }, | |
| "images": { | |
| "items": { | |
| "$ref": "#/components/schemas/image" | |
| }, | |
| "type": "array" | |
| }, | |
| "local": { | |
| "$ref": "#/components/schemas/local" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_attributes_patch_form": { | |
| "properties": {}, | |
| "type": "object" | |
| }, | |
| "item_form": { | |
| "description": "The item form defines the data required to create an item.", | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "price": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dimensions": { | |
| "$ref": "#/components/schemas/dimensions" | |
| }, | |
| "images": { | |
| "items": { | |
| "$ref": "#/components/schemas/image_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_form_overlay": { | |
| "description": "The item form overlay defines data to merge into an item form.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dimensions": { | |
| "$ref": "#/components/schemas/dimensions" | |
| }, | |
| "images": { | |
| "items": { | |
| "$ref": "#/components/schemas/image_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_form_overlay_form": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "price": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "categories": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dimensions": { | |
| "$ref": "#/components/schemas/dimensions" | |
| }, | |
| "images": { | |
| "items": { | |
| "$ref": "#/components/schemas/image_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_link": { | |
| "description": "Describes how items from an incoming feed will link with localized items in a Flow catalog to create an outgoing feed.", | |
| "properties": { | |
| "incoming_field_name": { | |
| "$ref": "#/components/schemas/incoming_field_name" | |
| }, | |
| "flow_field_name": { | |
| "$ref": "#/components/schemas/flow_field_name" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_margin": { | |
| "description": "Defines a fixed and percent margin to apply to items matching a query.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "q": { | |
| "type": "string" | |
| }, | |
| "fixed": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percent": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_margin_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "item_margin_id": { | |
| "type": "string" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_margin_post_form": { | |
| "description": "A percent and/or fixed margin to apply to items based on query.", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "q": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "fixed": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percent": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_margin_put_form": { | |
| "description": "A percent and/or fixed margin to apply to items based on query.", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "q": { | |
| "type": "string" | |
| }, | |
| "fixed": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percent": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_margin_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "item_margin_id": { | |
| "type": "string" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "q": { | |
| "type": "string" | |
| }, | |
| "fixed": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percent": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_margin_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "item_margin": { | |
| "$ref": "#/components/schemas/item_margin" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_origin_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_origin_upserted": { | |
| "description": "Event raised whenever an item is assigned a country of origin. Note that one item may have multiple countries of origin.", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_price_update_put_form": { | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "price": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_query_suggestion": { | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| }, | |
| "count": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_reference": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_sales_margin_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "item_sales_margin_id": { | |
| "type": "string" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_sales_margin_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "item_sales_margin_id": { | |
| "type": "string" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "q": { | |
| "type": "string" | |
| }, | |
| "fixed": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percent": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_statistics": { | |
| "description": "Statistics covering product catalog item information, including total catalog item count, number of distinct categories, etc.", | |
| "properties": { | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "categories": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "item_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/item" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "jsonp_response": { | |
| "description": "The jsonp_response defines the schema for all Flow APIs calls made over JSONP, providing access to the specific response status, headers, and body from the underlying service. See https://docs.flow.io/#jsonp for details", | |
| "properties": { | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "body": { | |
| "type": "object" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "klaviyo_line_item": { | |
| "properties": { | |
| "content": { | |
| "$ref": "#/components/schemas/checkout_item_content" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "line_price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "klaviyo_order_content": { | |
| "properties": { | |
| "line_items": { | |
| "items": { | |
| "$ref": "#/components/schemas/klaviyo_line_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "prices": { | |
| "$ref": "#/components/schemas/klaviyo_order_prices" | |
| }, | |
| "checkout_url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "klaviyo_order_prices": { | |
| "description": "Contains cart related data.", | |
| "properties": { | |
| "subtotal": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "vat": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "shipping": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "insurance": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "label_format_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "label_format_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| }, | |
| "format": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "label_order_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "label_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "label_id": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "commercial_invoice": { | |
| "type": "string" | |
| }, | |
| "flow_tracking_number": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "origin": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "carrier": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| }, | |
| "zpl": { | |
| "type": "string" | |
| }, | |
| "pdf": { | |
| "type": "string" | |
| }, | |
| "png": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number_url": { | |
| "type": "string" | |
| }, | |
| "flow_tracking_number_url": { | |
| "type": "string" | |
| }, | |
| "center_key": { | |
| "type": "string" | |
| }, | |
| "recipient": { | |
| "$ref": "#/components/schemas/shipment_recipient" | |
| }, | |
| "package": { | |
| "$ref": "#/components/schemas/shipping_label_package" | |
| }, | |
| "order_identifier": { | |
| "type": "string" | |
| }, | |
| "fulfillment_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "lane_landed_cost": { | |
| "description": "The tariff codes, duty rates and tax rates associated with an origin/destination pair. Does not take into account sales province", | |
| "properties": { | |
| "origin": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| }, | |
| "tariff_code": { | |
| "type": "string" | |
| }, | |
| "effective_duty": { | |
| "$ref": "#/components/schemas/duty" | |
| }, | |
| "tax": { | |
| "$ref": "#/components/schemas/tax" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "language": { | |
| "description": "ISO 639 2-character language code. See https://api.flow.io/reference/languages", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "iso_639_2": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "line": { | |
| "description": "Provides display data for a line item.", | |
| "properties": { | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "line_item": { | |
| "description": "Line items represent the items a consumer is purchasing, including additional information to complete the transaction. Note that you may pass in as many line items as you like - including repeating item numbers across line items.", | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "center": { | |
| "type": "string" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "line_item_form": { | |
| "description": "Line items represent the items a consumer is purchasing, including additional information to complete the transaction. Note that you may pass in as many line items as you like - including repeating item numbers across line items.", | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "shipment_estimate": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "center": { | |
| "type": "string" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "link": { | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "local": { | |
| "properties": { | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_summary" | |
| }, | |
| "prices": { | |
| "items": { | |
| "$ref": "#/components/schemas/localized_price" | |
| }, | |
| "type": "array" | |
| }, | |
| "rates": { | |
| "items": { | |
| "$ref": "#/components/schemas/rate" | |
| }, | |
| "type": "array" | |
| }, | |
| "spot_rates": { | |
| "items": { | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/subcatalog_item_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "local_item": { | |
| "description": "The Local Item represents all of the data for a given item that is localized to a given experience.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_summary" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/catalog_item_reference" | |
| }, | |
| "pricing": { | |
| "$ref": "#/components/schemas/local_item_pricing" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/subcatalog_item_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "local_item_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "local_item": { | |
| "$ref": "#/components/schemas/local_item" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "local_item_pricing": { | |
| "description": "Localized item pricing information", | |
| "properties": { | |
| "price": { | |
| "$ref": "#/components/schemas/localized_item_price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "local_item_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "local_item": { | |
| "$ref": "#/components/schemas/local_item" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "local_price_details": { | |
| "properties": { | |
| "base": { | |
| "$ref": "#/components/schemas/price_details" | |
| }, | |
| "local": { | |
| "$ref": "#/components/schemas/price_details" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/price_detail" | |
| }, | |
| "local_before_discount": { | |
| "$ref": "#/components/schemas/price_detail" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "local_session": { | |
| "description": "If we found an experience for the given session, the localized information will be presented here", | |
| "properties": { | |
| "country": { | |
| "$ref": "#/components/schemas/country" | |
| }, | |
| "currency": { | |
| "$ref": "#/components/schemas/currency" | |
| }, | |
| "language": { | |
| "$ref": "#/components/schemas/language" | |
| }, | |
| "locale": { | |
| "$ref": "#/components/schemas/locale" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_geo" | |
| }, | |
| "experiment": { | |
| "$ref": "#/components/schemas/session_experiment" | |
| } | |
| }, | |
| "deprecated": true, | |
| "type": "object" | |
| }, | |
| "locale": { | |
| "description": "Locales defines standard conventions for presentation of content. See https://api.flow.io/reference/locales", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "numbers": { | |
| "$ref": "#/components/schemas/locale_numbers" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "locale_numbers": { | |
| "description": "Number formats defined for a given locale", | |
| "properties": { | |
| "decimal": { | |
| "type": "string" | |
| }, | |
| "group": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "localized_adjustment": { | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "reason": { | |
| "$ref": "#/components/schemas/adjustment_reason" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "localized_item_duty": { | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "adjustment": { | |
| "$ref": "#/components/schemas/localized_adjustment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "localized_item_price": { | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "includes": { | |
| "$ref": "#/components/schemas/included_levies" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "localized_item_prices_export_type": { | |
| "description": "Exports localized item prices data", | |
| "properties": { | |
| "since": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "localized_item_vat": { | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "adjustment": { | |
| "$ref": "#/components/schemas/localized_adjustment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "localized_line_item": { | |
| "description": "Line items on the order, with localized pricing information", | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "center": { | |
| "type": "string" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/localized_line_item_discount" | |
| }, | |
| "local": { | |
| "$ref": "#/components/schemas/local" | |
| }, | |
| "shipment_estimate": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "localized_line_item_discount": { | |
| "description": "Represents the requested, base, and localized amounts for a discount on a given line item. It applies to the entire line regardless of quantity.", | |
| "properties": { | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "requested": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "localized_total": { | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "localized_translation": { | |
| "description": "Localized translation of a given province/region/country", | |
| "properties": { | |
| "locale": { | |
| "$ref": "#/components/schemas/locale" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "logistics_settings": { | |
| "properties": { | |
| "shipping_configuration": { | |
| "$ref": "#/components/schemas/shipping_configuration_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "manifest": { | |
| "description": "Represents closeout of a group of labels that have been transferred to the carrier for shipping", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "shipping_labels": { | |
| "items": { | |
| "$ref": "#/components/schemas/shipping_label_summary" | |
| }, | |
| "type": "array" | |
| }, | |
| "pdf": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "$ref": "#/components/schemas/service_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "manifest_form": { | |
| "properties": { | |
| "tracking_numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "manifested_label_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "manifested_label_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "manifest_id": { | |
| "type": "string" | |
| }, | |
| "label_id": { | |
| "type": "string" | |
| }, | |
| "flow_tracking_number": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "order_identifier": { | |
| "type": "string" | |
| }, | |
| "fulfillment_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "margin": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/margin_type" | |
| }, | |
| "value": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "measurement": { | |
| "properties": { | |
| "value": { | |
| "type": "string" | |
| }, | |
| "units": { | |
| "$ref": "#/components/schemas/unit_of_measurement" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "membership": { | |
| "description": "Represents the users that are part of this organization. Primary purpose is to manage which users have access to the organization's data and to provide a simple user interface to assign roles and permissions to each member of the organization", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "$ref": "#/components/schemas/expandable_organization" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/expandable_user" | |
| }, | |
| "role": { | |
| "$ref": "#/components/schemas/role" | |
| }, | |
| "roles": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_role" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "membership_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "membership": { | |
| "$ref": "#/components/schemas/membership" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "membership_form": { | |
| "description": "Top level resource to create a membership.", | |
| "properties": { | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "type": "string" | |
| }, | |
| "role": { | |
| "$ref": "#/components/schemas/role" | |
| }, | |
| "roles": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_role" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "membership_put_form": { | |
| "description": "Top level resource to update a membership.", | |
| "properties": { | |
| "role": { | |
| "$ref": "#/components/schemas/role" | |
| }, | |
| "roles": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_role" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "membership_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "membership": { | |
| "$ref": "#/components/schemas/membership" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "membership_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "membership": { | |
| "$ref": "#/components/schemas/membership" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "merchant_of_record_authorization_form": { | |
| "description": "Creates an authorization for a transaction for which Flow is the merchant of record. In this case, you must provide your order number for a valid Flow order. An authorization is used to check and reserve funds w/ a given payment method. No funds are actually transferred; once you have you an authorization, you can capture up to the amount of the authorization", | |
| "properties": { | |
| "token": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "cvv": { | |
| "type": "string" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "options": { | |
| "items": { | |
| "$ref": "#/components/schemas/authorization_option" | |
| }, | |
| "type": "array" | |
| }, | |
| "redirect_urls": { | |
| "$ref": "#/components/schemas/post_payment_redirect_urls" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "merchant_of_record_entity": { | |
| "description": "The merchant of record entity provides the legal name and address of the specific Flow entity serving as merchant of record.", | |
| "properties": { | |
| "organization": { | |
| "$ref": "#/components/schemas/organization_reference" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "vat": { | |
| "$ref": "#/components/schemas/merchant_of_record_entity_registration" | |
| }, | |
| "streets": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "province": { | |
| "type": "string" | |
| }, | |
| "postal": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "merchant_of_record_entity_registration": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "merchant_of_record_payment_form": { | |
| "description": "Creates an online payment", | |
| "properties": { | |
| "method": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "money": { | |
| "description": "Money represents an amount in a given currency", | |
| "properties": { | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "money_with_base": { | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "money_with_optional_base": { | |
| "description": "Used to migrate older models to have a base value, without breaking compatibility", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "name": { | |
| "properties": { | |
| "first": { | |
| "type": "string" | |
| }, | |
| "last": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "name_form": { | |
| "properties": { | |
| "first": { | |
| "type": "string" | |
| }, | |
| "last": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "no_inventory_reservation_error": { | |
| "properties": { | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/no_inventory_reservation_error_item" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "no_inventory_reservation_error_item": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "requested_quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "available_quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "notification_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "notification_id": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "flow_tracking_number": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "origin": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "carrier": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "string" | |
| }, | |
| "package": { | |
| "$ref": "#/components/schemas/shipping_label_package" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "notification_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "notification_id": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "flow_tracking_number": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "origin": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "carrier": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "string" | |
| }, | |
| "order_identifier": { | |
| "type": "string" | |
| }, | |
| "fulfillment_key": { | |
| "type": "string" | |
| }, | |
| "package": { | |
| "$ref": "#/components/schemas/shipping_label_package" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "number_range": { | |
| "properties": { | |
| "min": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "max": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "online_authorization": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "method": { | |
| "$ref": "#/components/schemas/payment_method" | |
| }, | |
| "merchant_of_record": { | |
| "$ref": "#/components/schemas/merchant_of_record" | |
| }, | |
| "details": { | |
| "$ref": "#/components/schemas/online_authorization_details" | |
| }, | |
| "payment": { | |
| "type": "object" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "requested": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "customer": { | |
| "$ref": "#/components/schemas/customer" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "billing_address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/authorization_order_reference" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "result": { | |
| "$ref": "#/components/schemas/authorization_result" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "expires_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "online_authorization_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/online_authorization" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "online_authorization_upserted_v2": { | |
| "description": "Represents an authorization for a card payment method", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/online_authorization" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "optin_response": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "$ref": "#/components/schemas/optin_response_type" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "option_weight_estimates": { | |
| "properties": { | |
| "gravitational": { | |
| "$ref": "#/components/schemas/measurement" | |
| }, | |
| "dimensional": { | |
| "$ref": "#/components/schemas/measurement" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "options": { | |
| "description": "Flags to indicate whether a feature is enabled/disabled on a particular model (e.g. show/do not show attribute as a column in harmonization table view of items)", | |
| "properties": { | |
| "required": { | |
| "type": "boolean" | |
| }, | |
| "show_in_catalog": { | |
| "type": "boolean" | |
| }, | |
| "show_in_harmonization": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order": { | |
| "description": "An order represents all of the information about a particular set of line items, including pricing, currency rates, delivery options, etc. All information in an order is guaranteed by Flow - if an order is submitted before its expiration. The intended use case is to create an order as a consumer enters checkout, then to submit that order as part of the user submitting their order. Note that Flow will automatically mark an order submitted if we see payment authorization(s) covering the full balance of an order.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "merchant_of_record": { | |
| "$ref": "#/components/schemas/order_merchant_of_record" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/expandable_experience" | |
| }, | |
| "customer": { | |
| "$ref": "#/components/schemas/customer" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| }, | |
| "expires_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/localized_line_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "deliveries": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery" | |
| }, | |
| "type": "array" | |
| }, | |
| "selections": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "prices": { | |
| "items": { | |
| "$ref": "#/components/schemas/order_price_detail" | |
| }, | |
| "type": "array" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/localized_total" | |
| }, | |
| "submitted_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "lines": { | |
| "items": { | |
| "$ref": "#/components/schemas/line" | |
| }, | |
| "type": "array" | |
| }, | |
| "identifiers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "promotions": { | |
| "$ref": "#/components/schemas/promotions" | |
| }, | |
| "payments": { | |
| "items": { | |
| "$ref": "#/components/schemas/order_payment" | |
| }, | |
| "type": "array" | |
| }, | |
| "balance": { | |
| "$ref": "#/components/schemas/localized_total" | |
| }, | |
| "rules": { | |
| "$ref": "#/components/schemas/order_rules_summary" | |
| }, | |
| "tax_registration": { | |
| "$ref": "#/components/schemas/tax_registration" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_address": { | |
| "properties": { | |
| "text": { | |
| "type": "string" | |
| }, | |
| "streets": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "province": { | |
| "type": "string" | |
| }, | |
| "postal": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "latitude": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "string" | |
| }, | |
| "contact": { | |
| "$ref": "#/components/schemas/contact" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_builder": { | |
| "description": "The Order Builder model is used to incrementally build up an order until it is complete and can be submitted.", | |
| "properties": { | |
| "order": { | |
| "$ref": "#/components/schemas/order" | |
| }, | |
| "errors": { | |
| "items": { | |
| "$ref": "#/components/schemas/order_error" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_builder_attributes_form": { | |
| "properties": {}, | |
| "type": "object" | |
| }, | |
| "order_builder_delivered_duty_form": { | |
| "properties": { | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_builder_destination_country_form": { | |
| "properties": { | |
| "country": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_builder_destination_form": { | |
| "properties": { | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/order" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_destination_put_form": { | |
| "description": "Purpose-built form specifically for only address-related changes to destination on an order", | |
| "properties": { | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/order_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "destination_country": { | |
| "$ref": "#/components/schemas/country" | |
| }, | |
| "threshold": { | |
| "$ref": "#/components/schemas/value_threshold_exceeded_details" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_estimate": { | |
| "description": "Lightweight estimate for a group of items without any customer-related information. This will contain available estimates on shipping, taxes, and duties.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/localized_line_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| }, | |
| "deliveries": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery" | |
| }, | |
| "type": "array" | |
| }, | |
| "prices": { | |
| "items": { | |
| "$ref": "#/components/schemas/order_price_detail" | |
| }, | |
| "type": "array" | |
| }, | |
| "selections": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/localized_total" | |
| }, | |
| "lines": { | |
| "items": { | |
| "$ref": "#/components/schemas/line" | |
| }, | |
| "type": "array" | |
| }, | |
| "promotions": { | |
| "$ref": "#/components/schemas/promotions" | |
| } | |
| }, | |
| "deprecated": true, | |
| "type": "object" | |
| }, | |
| "order_estimate_form": { | |
| "description": "Form to get a lightweight estimate of an order.", | |
| "properties": { | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/line_item_form" | |
| }, | |
| "type": "array" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| }, | |
| "selections": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "deprecated": true, | |
| "type": "object" | |
| }, | |
| "order_export_type": { | |
| "description": "Exports orders", | |
| "properties": { | |
| "numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "min_hours_since_submitted_at": { | |
| "type": "integer" | |
| }, | |
| "submitted_on_or_before": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "submitted_on_or_after": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/order_status" | |
| }, | |
| "has_tracking_label": { | |
| "type": "boolean" | |
| }, | |
| "sort": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_form": { | |
| "description": "The order form is used to create an open order, providing the details on pricing and delivery options for destination and items/quantities specified", | |
| "properties": { | |
| "customer": { | |
| "$ref": "#/components/schemas/customer" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/line_item_form" | |
| }, | |
| "type": "array" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "authorization_keys": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_fraud_status": { | |
| "properties": { | |
| "order": { | |
| "$ref": "#/components/schemas/order_reference" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/fraud_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_geo": { | |
| "description": "The geolocated information for an order", | |
| "properties": { | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_identifier": { | |
| "description": "Represents alternate identifiers that can be used to lookup an order. Common use cases are to support attaching a primary identifier (e.g. a nice order number) post order submission or attaching IDs that are used by the warehouse to ship the orders.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/order_reference" | |
| }, | |
| "identifier": { | |
| "type": "string" | |
| }, | |
| "primary": { | |
| "type": "boolean" | |
| }, | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_identifier_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_identifier_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_identifier_form": { | |
| "properties": { | |
| "order": { | |
| "type": "string" | |
| }, | |
| "identifier": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "primary": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_identifier_put_form": { | |
| "properties": { | |
| "order": { | |
| "type": "string" | |
| }, | |
| "primary": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_identifier_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_identifier_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "identifier": { | |
| "type": "string" | |
| }, | |
| "primary": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_identifier_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "order_identifier": { | |
| "$ref": "#/components/schemas/order_identifier" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_number_generator_defaults": { | |
| "properties": { | |
| "starts_with": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "min_hex_length": { | |
| "type": "integer" | |
| }, | |
| "min_starts_with": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_number_generator_fixed_length": { | |
| "properties": { | |
| "length": { | |
| "type": "integer" | |
| }, | |
| "padding": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_number_generator_hexadecimal": { | |
| "description": "Hexadecimal generator generates a random string, starting with a letter, of a given length", | |
| "properties": { | |
| "length": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_number_generator_prefix_suffix": { | |
| "description": "Generator with an optional prefix, followed by an integer and an optional suffix", | |
| "properties": { | |
| "prefix": { | |
| "type": "string" | |
| }, | |
| "starts_with": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "suffix": { | |
| "type": "string" | |
| }, | |
| "fixed_length": { | |
| "$ref": "#/components/schemas/order_number_generator_fixed_length" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_number_generator_uuid": { | |
| "description": "Generates an order number based on a UUID (no dashes or other formatting). This is the default for Flow orders (with order number prefixed by ord-)", | |
| "properties": { | |
| "prefix": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_number_reference": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_payment": { | |
| "description": "An Order Payment represents an individual payment applied to an order. The type of the payment can be used to further lookup transaction level detail", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/order_payment_type" | |
| }, | |
| "merchant_of_record": { | |
| "$ref": "#/components/schemas/merchant_of_record" | |
| }, | |
| "reference": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "address": { | |
| "$ref": "#/components/schemas/billing_address" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_placed": { | |
| "description": "Sent when an order is submitted, allocations are generated and the total value of the order is accounted for by discounts, subsidies, credits and authorized payments -- but may not ready to fulfill (e.g. pending assignment of a DC or fraud review). Intended to fuel customer feedback and alert merchants that an order is coming.", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/order" | |
| }, | |
| "allocation": { | |
| "$ref": "#/components/schemas/allocation_v2" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_price_detail": { | |
| "description": "Represents a top-level order price detail, e.g. 'Subtotal' or 'VAT'.", | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/order_price_detail_key" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "components": { | |
| "items": { | |
| "$ref": "#/components/schemas/order_price_detail_component" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "rate": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_price_detail_component": { | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/order_price_detail_component_key" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_promotion_trigger": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/promotion_trigger_type" | |
| }, | |
| "min": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_put_form": { | |
| "description": "The order put form is used to upsert an order, providing the details on pricing and delivery options for destination and items/quantities specified.", | |
| "properties": { | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/line_item_form" | |
| }, | |
| "type": "array" | |
| }, | |
| "customer": { | |
| "$ref": "#/components/schemas/customer" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "selections": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "authorization_keys": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_rule_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_rules_summary": { | |
| "properties": { | |
| "applied": { | |
| "items": { | |
| "$ref": "#/components/schemas/order_rule_reference" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "environment": { | |
| "type": "string" | |
| }, | |
| "experience_id": { | |
| "type": "string" | |
| }, | |
| "expires_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "customer": { | |
| "$ref": "#/components/schemas/customer" | |
| }, | |
| "selections": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/localized_line_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| }, | |
| "deliveries": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery" | |
| }, | |
| "type": "array" | |
| }, | |
| "prices": { | |
| "items": { | |
| "$ref": "#/components/schemas/order_price_detail" | |
| }, | |
| "type": "array" | |
| }, | |
| "order_id": { | |
| "type": "string" | |
| }, | |
| "payments": { | |
| "items": { | |
| "$ref": "#/components/schemas/order_payment" | |
| }, | |
| "type": "array" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "delivered_duty": { | |
| "type": "string" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/localized_total" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "updated_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "submitted_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "lines": { | |
| "items": { | |
| "$ref": "#/components/schemas/line" | |
| }, | |
| "type": "array" | |
| }, | |
| "geo": { | |
| "$ref": "#/components/schemas/order_geo" | |
| }, | |
| "merchant_of_record": { | |
| "$ref": "#/components/schemas/order_merchant_of_record" | |
| }, | |
| "tax_registration": { | |
| "$ref": "#/components/schemas/tax_registration" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/order" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "order_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/order" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization": { | |
| "description": "Represents a single organization in the system, and what environment it is currently operating in.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "parent": { | |
| "$ref": "#/components/schemas/organization_reference" | |
| }, | |
| "defaults": { | |
| "$ref": "#/components/schemas/organization_defaults" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_authorization": { | |
| "description": "Defines the data used for broad authorization of user access to org level data", | |
| "properties": { | |
| "role": { | |
| "$ref": "#/components/schemas/role" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_authorization_form": { | |
| "properties": { | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_countries_data": { | |
| "properties": { | |
| "available": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_countries_published": { | |
| "description": "Represents the list of countries that are currently marked available for an organization. This is a bulk event - meaning any time an organization enables or disables a specific region, we publish the new list of all of the countries that the organization is making available to its consumers.", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/organization_countries_data" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_currency_setting": { | |
| "description": "Represents organization-specific currency conversion adjustments.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "type": "string" | |
| }, | |
| "target": { | |
| "type": "string" | |
| }, | |
| "margin": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_currency_setting_form": { | |
| "description": "Represents the parts of an organization setting that can be updated.", | |
| "properties": { | |
| "base": { | |
| "type": "string" | |
| }, | |
| "target": { | |
| "type": "string" | |
| }, | |
| "margin": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_currency_setting_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "organization_currency_setting": { | |
| "$ref": "#/components/schemas/organization_currency_setting" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_defaults": { | |
| "properties": { | |
| "country": { | |
| "type": "string" | |
| }, | |
| "base_currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "$ref": "#/components/schemas/organization" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_form": { | |
| "description": "Either id or name is required.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "parent_id": { | |
| "type": "string" | |
| }, | |
| "defaults": { | |
| "$ref": "#/components/schemas/organization_defaults" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_put_form": { | |
| "description": "Data required to upsert an organization.", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "parent_id": { | |
| "type": "string" | |
| }, | |
| "defaults": { | |
| "$ref": "#/components/schemas/organization_defaults" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_rates_data": { | |
| "properties": { | |
| "rates": { | |
| "items": { | |
| "$ref": "#/components/schemas/rate" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_rates_published": { | |
| "description": "Represents the full list of exchange rates in effect for an organization. This is a bulk event - meaning any time an individual rate changes, we publish the new complete list of exchange rates. Note this event is published a few minutes after a rate is published, allowing us to aggregate multiple changes in a short period of time to reduce the number of organization_rates_published we publish.", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/organization_rates_data" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_session": { | |
| "description": "Represents a session created for an organization. Primary method to select an experience for a given user session and ensure that experience does not change throughout the user's activity. Provides authentication to objects created during this session (e.g. order).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "visitor": { | |
| "$ref": "#/components/schemas/session_visitor" | |
| }, | |
| "visit": { | |
| "$ref": "#/components/schemas/session_visit" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "local": { | |
| "$ref": "#/components/schemas/local_session" | |
| }, | |
| "geo": { | |
| "$ref": "#/components/schemas/session_geo" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_geo" | |
| }, | |
| "format": { | |
| "$ref": "#/components/schemas/session_format" | |
| }, | |
| "experiment": { | |
| "$ref": "#/components/schemas/session_experiment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_session_authorization": { | |
| "description": "Represents a session authorized access to the specified organization's data", | |
| "properties": { | |
| "organization": { | |
| "$ref": "#/components/schemas/organization_reference" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_short_id": { | |
| "description": "A short identifier for an organization that is used to setup account IDs, invoice Prefixes, etc.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "$ref": "#/components/schemas/organization_reference" | |
| }, | |
| "short_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_short_id_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization_short_id": { | |
| "$ref": "#/components/schemas/organization_short_id" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_short_id_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization_short_id": { | |
| "$ref": "#/components/schemas/organization_short_id" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_token": { | |
| "description": "All of the metadata associated with a given token.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "$ref": "#/components/schemas/organization_reference" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/user_reference" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "partial": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_token_form": { | |
| "description": "Used to create a new token. User making the request must be authorized to create a token for this organization.", | |
| "properties": { | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_token_reference": { | |
| "description": "Summary data for a given token", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "$ref": "#/components/schemas/organization_reference" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/user_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "environment": { | |
| "type": "string" | |
| }, | |
| "currencies": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "parent_id": { | |
| "type": "string" | |
| }, | |
| "default_base_currency": { | |
| "type": "string" | |
| }, | |
| "default_country": { | |
| "type": "string" | |
| }, | |
| "default_language": { | |
| "type": "string" | |
| }, | |
| "default_locale": { | |
| "type": "string" | |
| }, | |
| "default_timezone": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "$ref": "#/components/schemas/organization" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "organization_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "organization": { | |
| "$ref": "#/components/schemas/organization" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "original_prices": { | |
| "description": "Model representing original and max values and currencies.", | |
| "properties": { | |
| "value": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "max": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "outbound_carton_fee": { | |
| "properties": { | |
| "amount": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "outgoing_feed": { | |
| "description": "Describes the outgoing feed constructed by Flow", | |
| "properties": { | |
| "format": { | |
| "$ref": "#/components/schemas/outgoing_feed_format" | |
| }, | |
| "minute": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "outgoing_feed_form": { | |
| "description": "Describes the outgoing feed constructed by Flow", | |
| "properties": { | |
| "format": { | |
| "$ref": "#/components/schemas/outgoing_feed_format" | |
| }, | |
| "minute": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "packaging": { | |
| "description": "Represents packaging available to ship items", | |
| "properties": { | |
| "dimensions": { | |
| "$ref": "#/components/schemas/dimensions" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "partner_center": { | |
| "description": "Represents information about a partner (e.g. external 3PL) running the fulfillment center", | |
| "properties": { | |
| "partner_reference": { | |
| "$ref": "#/components/schemas/partner_reference" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "fees": { | |
| "items": { | |
| "$ref": "#/components/schemas/partner_center_fee" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "partner_center_form": { | |
| "properties": { | |
| "partner_id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "fees": { | |
| "items": { | |
| "$ref": "#/components/schemas/partner_center_fee" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "partner_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "partner_token": { | |
| "description": "All of the metadata associated with a given token.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "partner": { | |
| "$ref": "#/components/schemas/token_partner_reference" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/user_reference" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "partial": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "partner_token_form": { | |
| "description": "Used to create a new token. User making the request must be authorized to create a token for this partner.", | |
| "properties": { | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "partner_token_reference": { | |
| "description": "Summary data for a given token", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "partner": { | |
| "$ref": "#/components/schemas/token_partner_reference" | |
| }, | |
| "environment": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/user_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "password_change_form": { | |
| "properties": { | |
| "current": { | |
| "type": "string" | |
| }, | |
| "new": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "password_reset_form": { | |
| "properties": { | |
| "token": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "password_reset_request_form": { | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_error": { | |
| "description": "Details for why a payment failed", | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "codes": { | |
| "items": { | |
| "$ref": "#/components/schemas/payment_error_code" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_method": { | |
| "description": "Represents a single payment method - e.g VISA or Paypal - and any associated metadata required for processing", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/payment_method_type" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "images": { | |
| "$ref": "#/components/schemas/payment_method_images" | |
| }, | |
| "regions": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_method_image": { | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "width": { | |
| "type": "integer" | |
| }, | |
| "height": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_method_images": { | |
| "properties": { | |
| "small": { | |
| "$ref": "#/components/schemas/payment_method_image" | |
| }, | |
| "medium": { | |
| "$ref": "#/components/schemas/payment_method_image" | |
| }, | |
| "large": { | |
| "$ref": "#/components/schemas/payment_method_image" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_method_issuer": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_method_rule": { | |
| "properties": { | |
| "tags": { | |
| "items": { | |
| "$ref": "#/components/schemas/payment_method_tag" | |
| }, | |
| "type": "array" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/components/schemas/payment_method" | |
| }, | |
| "display_position": { | |
| "type": "integer" | |
| }, | |
| "content": { | |
| "items": { | |
| "$ref": "#/components/schemas/payment_method_rule_content" | |
| }, | |
| "type": "array" | |
| }, | |
| "issuers": { | |
| "items": { | |
| "$ref": "#/components/schemas/payment_method_issuer" | |
| }, | |
| "type": "array" | |
| }, | |
| "programs": { | |
| "items": { | |
| "$ref": "#/components/schemas/installment_program_summary" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_method_rule_content": { | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/payment_method_rule_content_key" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_paypal": { | |
| "description": "Represents an online payment processed through PayPal.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/authorization_order_reference" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "paypal": { | |
| "$ref": "#/components/schemas/payment_paypal_data" | |
| } | |
| }, | |
| "deprecated": true, | |
| "type": "object" | |
| }, | |
| "payment_paypal_data": { | |
| "description": "Represents on line payment", | |
| "properties": { | |
| "payment_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "deprecated": true, | |
| "type": "object" | |
| }, | |
| "payment_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "payment": { | |
| "$ref": "#/components/schemas/payment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "payment_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "payment": { | |
| "$ref": "#/components/schemas/payment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "paypal_authorization_details": { | |
| "description": "Represents on line payment", | |
| "properties": { | |
| "payment_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "paypal_authorization_form": { | |
| "description": "Executes the PayPal payment", | |
| "properties": { | |
| "paypal_payment_id": { | |
| "type": "string" | |
| }, | |
| "paypal_payer_id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "percent_margin": { | |
| "description": "Rule outcome where shipping surfaced in quote is actual cost plus a predefined margin percentage", | |
| "properties": { | |
| "percentage": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "permission_audit": { | |
| "description": "Returns all known permissions, along with their authorization technique and all of the roles which contain them.", | |
| "properties": { | |
| "routes": { | |
| "items": { | |
| "$ref": "#/components/schemas/route_audit" | |
| }, | |
| "type": "array" | |
| }, | |
| "behaviors": { | |
| "items": { | |
| "$ref": "#/components/schemas/behavior_audit" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "permission_check": { | |
| "description": "Used to test an integration's permissions, including identifying the authentication technique that will be used for similar requests.", | |
| "properties": { | |
| "authentication_technique": { | |
| "$ref": "#/components/schemas/authentication_technique" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/expandable_user" | |
| }, | |
| "roles": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_role" | |
| }, | |
| "type": "array" | |
| }, | |
| "behaviors": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_behavior" | |
| }, | |
| "type": "array" | |
| }, | |
| "routes": { | |
| "items": { | |
| "$ref": "#/components/schemas/permitted_route" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "permission_error": { | |
| "description": "Returned if no permissions are available for a request.", | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/generic_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "granting_roles": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_role" | |
| }, | |
| "type": "array" | |
| }, | |
| "admin_users": { | |
| "items": { | |
| "$ref": "#/components/schemas/user" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "permitted_route": { | |
| "description": "A Flow API route and method.", | |
| "properties": { | |
| "method": { | |
| "$ref": "#/components/schemas/permitted_http_method" | |
| }, | |
| "path": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "pfs_inventory_check_response": { | |
| "properties": {}, | |
| "type": "object" | |
| }, | |
| "pfs_inventory_check_response_item": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "ats": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "in_stock": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "pfs_inventory_status": { | |
| "properties": { | |
| "status": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "phrase_hint": { | |
| "properties": { | |
| "phrase": { | |
| "type": "string" | |
| }, | |
| "tariff_code": { | |
| "$ref": "#/components/schemas/tariff_code" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "phrase_hint_form": { | |
| "properties": { | |
| "phrase": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "physical_delivery": { | |
| "description": "Represents a collection of items, the available delivery option tier for that collection of items, and metadata about those options", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/center_summary" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "options": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery_option" | |
| }, | |
| "type": "array" | |
| }, | |
| "special_services": { | |
| "items": { | |
| "$ref": "#/components/schemas/physical_delivery_special_serivce" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "post_payment_redirect_urls": { | |
| "description": "The URLs to which the customer will be redirected based on the authorization status.", | |
| "properties": { | |
| "success": { | |
| "type": "string" | |
| }, | |
| "failure": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price": { | |
| "description": "Represents an amount-currency pair for a basic price", | |
| "properties": { | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "label": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book": { | |
| "description": "Represents a list of target prices in a specific currency that can override any subset of item prices within an experience.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "includes": { | |
| "$ref": "#/components/schemas/included_levies" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/price_book_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_form": { | |
| "description": "Represents a price book for a specific currency that can override any subset of item prices within an experience.", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "includes": { | |
| "$ref": "#/components/schemas/included_levy_key" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/price_book_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_item": { | |
| "description": "Represents the price of a single item within a price book.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "price_book": { | |
| "$ref": "#/components/schemas/price_book_reference" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "schedule": { | |
| "$ref": "#/components/schemas/price_book_item_schedule" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_item_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_item_form": { | |
| "description": "Represents the form to create an item in a pricebook.", | |
| "properties": { | |
| "price_book_key": { | |
| "type": "string" | |
| }, | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "schedule": { | |
| "$ref": "#/components/schemas/price_book_item_schedule" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_item_query_form": { | |
| "description": "Used to create price book items for multiple items matching a query", | |
| "properties": { | |
| "price_book_key": { | |
| "type": "string" | |
| }, | |
| "item_query": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "schedule": { | |
| "$ref": "#/components/schemas/price_book_item_schedule" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_item_schedule": { | |
| "description": "Represents schedule applied to a price book item", | |
| "properties": { | |
| "starts_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "ends_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_item_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "price_book_item": { | |
| "$ref": "#/components/schemas/price_book_item" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_book_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "price_book": { | |
| "$ref": "#/components/schemas/price_book" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_check": { | |
| "properties": { | |
| "display": { | |
| "$ref": "#/components/schemas/local_price_details" | |
| }, | |
| "final": { | |
| "$ref": "#/components/schemas/local_price_details" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_detail": { | |
| "description": "Represents a top-level price detail, e.g. 'Subtotal' or 'VAT'.", | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/price_detail_key" | |
| }, | |
| "components": { | |
| "items": { | |
| "$ref": "#/components/schemas/price_detail_component" | |
| }, | |
| "type": "array" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_detail_component": { | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/price_detail_component_key" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_details": { | |
| "description": "Detailed information for the pricing of a given item within an experience.", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "item_price": { | |
| "$ref": "#/components/schemas/price_detail" | |
| }, | |
| "margins": { | |
| "$ref": "#/components/schemas/price_detail" | |
| }, | |
| "vat": { | |
| "$ref": "#/components/schemas/price_detail" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/price_detail" | |
| }, | |
| "rounding": { | |
| "$ref": "#/components/schemas/price_detail" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "adjustment": { | |
| "$ref": "#/components/schemas/price_detail" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_equation": { | |
| "properties": { | |
| "contracted_rate": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "rate": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "pricing": { | |
| "$ref": "#/components/schemas/pricing" | |
| }, | |
| "base_price": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "discount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "fixed_margin": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percent_margin": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "insurance": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "freight": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/duty" | |
| }, | |
| "tax": { | |
| "$ref": "#/components/schemas/tax" | |
| }, | |
| "percent_sales_margin": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_form": { | |
| "description": "Amount-currency paid for a basic price to be used in model forms, before a price label is created. Label in the main price model is created by the implementing api.", | |
| "properties": { | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_with_base": { | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "price_with_base_and_details": { | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "details": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery_option_cost_detail" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "pricing": { | |
| "description": "Pricing determines how the item price is calculated when items are requests via the experience.", | |
| "properties": { | |
| "vat": { | |
| "$ref": "#/components/schemas/pricing_levy_setting" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/pricing_levy_setting" | |
| }, | |
| "rounding": { | |
| "$ref": "#/components/schemas/rounding" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "pricing_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "pricing_settings": { | |
| "properties": { | |
| "editable": { | |
| "type": "boolean" | |
| }, | |
| "default_tax_display": { | |
| "$ref": "#/components/schemas/pricing_levy_setting" | |
| }, | |
| "default_duty_display": { | |
| "$ref": "#/components/schemas/pricing_levy_setting" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "pricing_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "experience_key": { | |
| "type": "string" | |
| }, | |
| "vat": { | |
| "type": "string" | |
| }, | |
| "duty": { | |
| "type": "string" | |
| }, | |
| "rounding_type": { | |
| "type": "string" | |
| }, | |
| "rounding_method": { | |
| "type": "string" | |
| }, | |
| "rounding_value": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "processing_estimate": { | |
| "properties": { | |
| "location": { | |
| "$ref": "#/components/schemas/delivery_window_location" | |
| }, | |
| "min_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "max_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/delivery_window_component_source" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "promotion_trigger": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/promotion_trigger_type" | |
| }, | |
| "min": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "remaining": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "promotion_trigger_form": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/promotion_trigger_type" | |
| }, | |
| "min": { | |
| "$ref": "#/components/schemas/price_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "promotions": { | |
| "properties": { | |
| "applied": { | |
| "items": { | |
| "$ref": "#/components/schemas/promotion" | |
| }, | |
| "type": "array" | |
| }, | |
| "available": { | |
| "items": { | |
| "$ref": "#/components/schemas/promotion" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "province": { | |
| "description": "A subdivision/province/state within a country. These conform to the ISO 3166-2 standard for country subdivisions. See https://api.flow.io/reference/provinces", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "iso_3166_2": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "province_type": { | |
| "$ref": "#/components/schemas/province_type" | |
| }, | |
| "translations": { | |
| "items": { | |
| "$ref": "#/components/schemas/localized_translation" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "public_key": { | |
| "description": "A public key is used to encrypt cards client side prior to submitting to the Flow vault.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "query": { | |
| "description": "The query model is used to present a query to a user, containing both the raw query as well as the filter representation of the query.", | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| }, | |
| "filters": { | |
| "items": { | |
| "$ref": "#/components/schemas/query_filter" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "query_builder": { | |
| "description": "The query builder model is used to build a query using structured filters. The end result is a single 'q' string - e.g. 'category:jewelry and brand:Flow'", | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| }, | |
| "filters": { | |
| "items": { | |
| "$ref": "#/components/schemas/query_filter" | |
| }, | |
| "type": "array" | |
| }, | |
| "available": { | |
| "items": { | |
| "$ref": "#/components/schemas/available_filter" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "query_builder_filter_form": { | |
| "properties": { | |
| "filters": { | |
| "items": { | |
| "$ref": "#/components/schemas/query_filter_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "query_builder_query_form": { | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "query_filter_structured": { | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| }, | |
| "field": { | |
| "type": "string" | |
| }, | |
| "operator": { | |
| "type": "string" | |
| }, | |
| "values": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "query_filter_structured_form": { | |
| "properties": { | |
| "field": { | |
| "type": "string" | |
| }, | |
| "operator": { | |
| "type": "string" | |
| }, | |
| "values": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "query_filter_unstructured": { | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "query_filter_unstructured_form": { | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "quote": { | |
| "description": "Represents a collection of deliveries and available options for fulfillment of that delivery", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "deliveries": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery" | |
| }, | |
| "type": "array" | |
| }, | |
| "selections": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivery_option_reference" | |
| }, | |
| "type": "array" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "delivered_duties": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "quote_error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/quote_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "item_numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "quote_form": { | |
| "properties": { | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "experience": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/line_item_form" | |
| }, | |
| "type": "array" | |
| }, | |
| "delivered_duty": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "delivered_duties": { | |
| "items": { | |
| "$ref": "#/components/schemas/delivered_duty" | |
| }, | |
| "type": "array" | |
| }, | |
| "direction": { | |
| "$ref": "#/components/schemas/tier_direction" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "quote_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "quote_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "quote": { | |
| "$ref": "#/components/schemas/quote_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "rate": { | |
| "description": "Represents an organization-specific currency conversion rate at a point in time.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "type": "string" | |
| }, | |
| "target": { | |
| "type": "string" | |
| }, | |
| "effective_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "value": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "rate_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "rate_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "rate_form": { | |
| "description": "Represents the parts of an organization rate that can be updated.", | |
| "properties": { | |
| "base": { | |
| "type": "string" | |
| }, | |
| "target": { | |
| "type": "string" | |
| }, | |
| "effective_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "rate_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "rate_id": { | |
| "type": "string" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "type": "string" | |
| }, | |
| "target": { | |
| "type": "string" | |
| }, | |
| "effective_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "value": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "rate_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "rate": { | |
| "$ref": "#/components/schemas/rate" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ready_to_fulfill": { | |
| "description": "Sent when an order is assigned to a fulfillment center in whole or in part. All assigned fulfillments for all centers will be included on the message.", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/order" | |
| }, | |
| "fulfillments": { | |
| "items": { | |
| "$ref": "#/components/schemas/fulfillment" | |
| }, | |
| "type": "array" | |
| }, | |
| "fulfillment_item_allocation_details": { | |
| "items": { | |
| "$ref": "#/components/schemas/fulfillment_item_allocation_details" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "redirect_authorization_details": { | |
| "description": "Represents an online payment that requires the user to redirect to another site before entering their payment information.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "payment_redirect_url": { | |
| "type": "string" | |
| }, | |
| "confirmation_details": { | |
| "$ref": "#/components/schemas/confirmation_details" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "redirect_authorization_form": { | |
| "description": "Executes a redirect-based payment based on the provided payment method.", | |
| "properties": { | |
| "method": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "$ref": "#/components/schemas/issuer_reference" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "redirect_urls": { | |
| "$ref": "#/components/schemas/post_payment_redirect_urls" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund": { | |
| "description": "Refunds can be created against either a specific capture or an authorization (in which case we will select 1 or more specific captures against which to execute the refund).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/authorization_reference" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "requested": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "captures": { | |
| "items": { | |
| "$ref": "#/components/schemas/refund_capture_summary" | |
| }, | |
| "type": "array" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/refund_status" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_capture": { | |
| "description": "Refund captures provide the detailed information on the amount refunded against a specific capture", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "refund": { | |
| "$ref": "#/components/schemas/refund" | |
| }, | |
| "capture": { | |
| "$ref": "#/components/schemas/capture" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/refund_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_capture_summary": { | |
| "description": "Refund captures provide the detailed information on the amount refunded against a specific capture", | |
| "properties": { | |
| "capture": { | |
| "$ref": "#/components/schemas/capture" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_capture_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "refund_capture": { | |
| "$ref": "#/components/schemas/refund_capture" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "refund": { | |
| "$ref": "#/components/schemas/refund" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/generic_error_code" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "decline_code": { | |
| "$ref": "#/components/schemas/refund_decline_code" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_form": { | |
| "description": "Refund actually transfers funds. You can refund as many times as you'd like up until the total amount of captured funds has been refunded. Note when creating a refund you can specify either an order authorization id, a capture id, or an order number (or all of them as long as they match).", | |
| "properties": { | |
| "authorization_id": { | |
| "type": "string" | |
| }, | |
| "capture_id": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "rma_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_identifier": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "refund": { | |
| "$ref": "#/components/schemas/refund_reference" | |
| }, | |
| "identifier": { | |
| "type": "string" | |
| }, | |
| "primary": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_identifier_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "identifier": { | |
| "$ref": "#/components/schemas/refund_identifier" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_identifier_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "identifier": { | |
| "$ref": "#/components/schemas/refund_identifier" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_order_summary": { | |
| "description": "For merchant of record authorizations, we provide a summary of refund information primarily to support customer service workflow.", | |
| "properties": { | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "captured": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "refunded": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "amounts": { | |
| "$ref": "#/components/schemas/refund_order_summary_amounts" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_order_summary_amounts": { | |
| "description": "Detailed examples of amount to refund following common e-commerce use cases.", | |
| "properties": { | |
| "balance": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "balance_excluding_shipping": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "shipping": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "refund": { | |
| "$ref": "#/components/schemas/refund" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "refund_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "refund": { | |
| "$ref": "#/components/schemas/refund" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "region": { | |
| "description": "A region represents a geographic area of the world. Regions can be countries, continents or other political areas (like the Eurozone). See https://api.flow.io/reference/regions", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "countries": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "currencies": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "languages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "measurement_systems": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "timezones": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "region_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "region_setting": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/availability_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "region_setting_form": { | |
| "properties": { | |
| "status": { | |
| "$ref": "#/components/schemas/availability_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reservation": { | |
| "description": "Inventory reservation for a set of items in organization that potentially expires at specified date/time", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/reservation_order_reference" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/reservation_item" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reservation_form": { | |
| "properties": { | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/reservation_item_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reservation_item": { | |
| "properties": { | |
| "item": { | |
| "$ref": "#/components/schemas/reservation_item_reference" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reservation_item_form": { | |
| "properties": { | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reservation_item_reference": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reservation_order_reference": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/return_line_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "labels": { | |
| "items": { | |
| "$ref": "#/components/schemas/shipping_label" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_form": { | |
| "properties": { | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/return_line_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "tier_id": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_item_reference": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_line_item": { | |
| "properties": { | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "reason": { | |
| "$ref": "#/components/schemas/return_reason" | |
| }, | |
| "notes": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_order_reference": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_reason": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_reason_form": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_reason_put_form": { | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/return_line_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "labels": { | |
| "items": { | |
| "$ref": "#/components/schemas/shipping_label" | |
| }, | |
| "type": "array" | |
| }, | |
| "service": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "return_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "return": { | |
| "$ref": "#/components/schemas/return" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reversal": { | |
| "description": "A reversal is used to clear an authorization (full or partial).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/authorization_reference" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/reversal_status" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "requested": { | |
| "$ref": "#/components/schemas/money" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "base": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reversal_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "reversal": { | |
| "$ref": "#/components/schemas/reversal" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reversal_error": { | |
| "description": "Details for why a reversal could not be created", | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "messages": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "codes": { | |
| "items": { | |
| "$ref": "#/components/schemas/reversal_error_code" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reversal_form": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "authorization_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reversal_put_form": { | |
| "properties": { | |
| "authorization_id": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reversal_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "reversal": { | |
| "$ref": "#/components/schemas/reversal" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "reversal_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "reversal": { | |
| "$ref": "#/components/schemas/reversal" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "rounding": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/rounding_type" | |
| }, | |
| "method": { | |
| "$ref": "#/components/schemas/rounding_method" | |
| }, | |
| "value": { | |
| "type": "number", | |
| "format": "float" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "route_audit": { | |
| "properties": { | |
| "method": { | |
| "$ref": "#/components/schemas/permitted_http_method" | |
| }, | |
| "path": { | |
| "type": "string" | |
| }, | |
| "authentication_techniques": { | |
| "items": { | |
| "$ref": "#/components/schemas/authentication_technique" | |
| }, | |
| "type": "array" | |
| }, | |
| "roles": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_role" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "rule_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "rule_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "rule": { | |
| "$ref": "#/components/schemas/inventory_rule" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "schedule": { | |
| "description": "Represents operating calendar and holidays of a center", | |
| "properties": { | |
| "calendar": { | |
| "$ref": "#/components/schemas/calendar" | |
| }, | |
| "holiday": { | |
| "$ref": "#/components/schemas/holiday_calendar" | |
| }, | |
| "exception": { | |
| "items": { | |
| "$ref": "#/components/schemas/exception" | |
| }, | |
| "type": "array" | |
| }, | |
| "cutoff": { | |
| "type": "string" | |
| }, | |
| "min_lead_time": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "max_lead_time": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "scheduled_export": { | |
| "description": "Allows a user to create a scheduled export that will be delivered on a schedule (currently only support once / day at a set time)", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/user_reference" | |
| }, | |
| "organization_q": { | |
| "type": "string" | |
| }, | |
| "hour": { | |
| "type": "integer" | |
| }, | |
| "minute": { | |
| "type": "integer" | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "types": { | |
| "items": { | |
| "$ref": "#/components/schemas/export_type" | |
| }, | |
| "type": "array" | |
| }, | |
| "last_sent_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "scheduled_export_form": { | |
| "properties": { | |
| "user_id": { | |
| "type": "string" | |
| }, | |
| "organization_q": { | |
| "type": "string" | |
| }, | |
| "hour": { | |
| "type": "integer" | |
| }, | |
| "minute": { | |
| "type": "integer" | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "types": { | |
| "items": { | |
| "$ref": "#/components/schemas/export_type" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "scheduled_pickup": { | |
| "properties": { | |
| "day_of_week": { | |
| "$ref": "#/components/schemas/day_of_week" | |
| }, | |
| "hour_of_day": { | |
| "type": "string" | |
| }, | |
| "minute_of_hour": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "serial": { | |
| "description": "A unique identifier assigned to an individual item.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "item_price": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/serial_status" | |
| }, | |
| "center": { | |
| "$ref": "#/components/schemas/center_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "serial_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "serial_form": { | |
| "description": "A unique identifier assigned to an individual item.", | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "item_price": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "item_currency": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/serial_status" | |
| }, | |
| "center_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "serial_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "serial": { | |
| "$ref": "#/components/schemas/serial" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "serial_version": { | |
| "description": "Retrieve journaled history of a serial", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "serial": { | |
| "$ref": "#/components/schemas/serial" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "service_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "service_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "carrier": { | |
| "$ref": "#/components/schemas/carrier_reference" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "center_code": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_authorization_form": { | |
| "description": "Authorize a request using a session id", | |
| "properties": { | |
| "session": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_currency_format": { | |
| "properties": { | |
| "symbol": { | |
| "$ref": "#/components/schemas/currency_symbol_format" | |
| }, | |
| "label_formatters": { | |
| "items": { | |
| "$ref": "#/components/schemas/currency_label_formatter" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_experiment": { | |
| "description": "Experiment for A/B testing", | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "variant": { | |
| "$ref": "#/components/schemas/session_experiment_variant" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_experiment_variant": { | |
| "description": "Experiment variant. Control or variant", | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_expiration_config": { | |
| "description": "Configures session expiration time. We default to 30 minutes to follow Google Analytics", | |
| "properties": { | |
| "unit": { | |
| "$ref": "#/components/schemas/unit_of_time" | |
| }, | |
| "value": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_form": { | |
| "properties": { | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "experiment": { | |
| "$ref": "#/components/schemas/session_experiment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_format": { | |
| "properties": { | |
| "currency": { | |
| "$ref": "#/components/schemas/session_currency_format" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_geo": { | |
| "description": "The geolocated information for this session", | |
| "properties": { | |
| "country": { | |
| "$ref": "#/components/schemas/country" | |
| }, | |
| "currency": { | |
| "$ref": "#/components/schemas/currency" | |
| }, | |
| "language": { | |
| "$ref": "#/components/schemas/language" | |
| }, | |
| "locale": { | |
| "$ref": "#/components/schemas/locale" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_put_form": { | |
| "properties": { | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "language": { | |
| "type": "string" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "experiment": { | |
| "$ref": "#/components/schemas/session_experiment" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_visit": { | |
| "description": "A session visit expires after a configurable period of inactivity (e.g. 30 minutes).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "expires_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "session_visitor": { | |
| "description": "A session visitor is a unique identifier for our best guess as to who the individual user is interacting with Flow.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_address": { | |
| "properties": { | |
| "contact": { | |
| "$ref": "#/components/schemas/contact" | |
| }, | |
| "location": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "center_key": { | |
| "type": "string" | |
| }, | |
| "center_reference": { | |
| "$ref": "#/components/schemas/center_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/shipping_configuration_type" | |
| }, | |
| "shipping_lanes": { | |
| "items": { | |
| "$ref": "#/components/schemas/shipping_lane" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_copy": { | |
| "properties": { | |
| "original": { | |
| "$ref": "#/components/schemas/shipping_configuration_reference" | |
| }, | |
| "new": { | |
| "$ref": "#/components/schemas/shipping_configuration_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_copy_form": { | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_form": { | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_item_availability": { | |
| "description": "Denormalized availability status of an item in a shipping configuration for a destination region", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/item_reference" | |
| }, | |
| "shipping_configuration": { | |
| "$ref": "#/components/schemas/shipping_configuration_summary" | |
| }, | |
| "availabilities": { | |
| "items": { | |
| "$ref": "#/components/schemas/country_availability" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_item_availability_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "shipping_configuration_item_availability": { | |
| "$ref": "#/components/schemas/shipping_configuration_item_availability" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_item_availability_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "shipping_configuration_item_availability": { | |
| "$ref": "#/components/schemas/shipping_configuration_item_availability" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_reference": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/shipping_configuration_type" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "shipping_configuration": { | |
| "$ref": "#/components/schemas/shipping_configuration" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_configuration_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "shipping_configuration": { | |
| "$ref": "#/components/schemas/shipping_configuration" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_label": { | |
| "description": "Represents information about a carrier-generated shipping label used by a shipper to transport a package from a given origin to destination", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number_url": { | |
| "type": "string" | |
| }, | |
| "cost": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "flow_tracking_number": { | |
| "type": "string" | |
| }, | |
| "flow_tracking_number_url": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "service": { | |
| "$ref": "#/components/schemas/service_summary" | |
| }, | |
| "window": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| }, | |
| "label": { | |
| "$ref": "#/components/schemas/shipping_label_document" | |
| }, | |
| "invoice": { | |
| "$ref": "#/components/schemas/shipping_label_document" | |
| }, | |
| "return": { | |
| "$ref": "#/components/schemas/shipping_label_document" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/label_order_summary" | |
| }, | |
| "package": { | |
| "$ref": "#/components/schemas/shipping_label_package" | |
| }, | |
| "order_identifier": { | |
| "type": "string" | |
| }, | |
| "fulfillment_key": { | |
| "type": "string" | |
| }, | |
| "shipment_recipient": { | |
| "$ref": "#/components/schemas/shipment_recipient" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_label_document": { | |
| "description": "Output data or downloadable links for shipping label documents such as labels or commercial invoices", | |
| "properties": { | |
| "zpl": { | |
| "type": "string" | |
| }, | |
| "pdf": { | |
| "type": "string" | |
| }, | |
| "png": { | |
| "type": "string" | |
| }, | |
| "html": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_label_package": { | |
| "description": "Describes a package to be shipped, including dimensions and items included", | |
| "properties": { | |
| "dimensions": { | |
| "$ref": "#/components/schemas/dimension" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/line_item_form" | |
| }, | |
| "type": "array" | |
| }, | |
| "reference_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_label_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "flow_tracking_number": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_label_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "shipping_label": { | |
| "$ref": "#/components/schemas/shipping_label" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_lane": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "shipping_configuration": { | |
| "$ref": "#/components/schemas/shipping_configuration_reference" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "centers": { | |
| "items": { | |
| "$ref": "#/components/schemas/expandable_center" | |
| }, | |
| "type": "array" | |
| }, | |
| "tiers": { | |
| "items": { | |
| "$ref": "#/components/schemas/tier" | |
| }, | |
| "type": "array" | |
| }, | |
| "query": { | |
| "$ref": "#/components/schemas/query" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_lane_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "shipping_lane": { | |
| "$ref": "#/components/schemas/shipping_lane" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_lane_form": { | |
| "properties": { | |
| "from": { | |
| "type": "string" | |
| }, | |
| "to": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_lane_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "shipping_lane": { | |
| "$ref": "#/components/schemas/shipping_lane" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_lane_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "shipping_lane": { | |
| "$ref": "#/components/schemas/shipping_lane" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_notification": { | |
| "description": "Represents information about a client-facilitated shipment where the shipping label and fulfillment was not handled by Flow. For merchant-of-record and tracking purposes, clients doing their own shipping will need to notify Flow of shipped packages.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "flow_tracking_number": { | |
| "type": "string" | |
| }, | |
| "origin": { | |
| "$ref": "#/components/schemas/shipping_address" | |
| }, | |
| "package": { | |
| "$ref": "#/components/schemas/shipping_label_package" | |
| }, | |
| "service": { | |
| "$ref": "#/components/schemas/service_summary" | |
| }, | |
| "window": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| }, | |
| "order": { | |
| "$ref": "#/components/schemas/label_order_summary" | |
| }, | |
| "order_identifier": { | |
| "type": "string" | |
| }, | |
| "fulfillment_key": { | |
| "type": "string" | |
| }, | |
| "shipment_recipient": { | |
| "$ref": "#/components/schemas/shipment_recipient" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shipping_notification_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "shipping_notification": { | |
| "$ref": "#/components/schemas/shipping_notification" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_cart": { | |
| "description": "Representation of a Shopify cart exactly as defined by shopify.com", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/shopify_cart_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "item_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "total_price": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "local": { | |
| "$ref": "#/components/schemas/shopify_local_cart_metadata" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "note": { | |
| "type": "string" | |
| }, | |
| "requires_shipping": { | |
| "type": "boolean" | |
| }, | |
| "total_weight": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_cart_add_multiple_form": { | |
| "properties": { | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/shopify_cart_add_single_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_cart_add_single_form": { | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_cart_change_form": { | |
| "description": "Must provide either line or id. If you provide both, they must match", | |
| "properties": { | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "line": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_cart_item": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "handle": { | |
| "type": "string" | |
| }, | |
| "line_price": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "price": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "product_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "product_title": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "variant_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "local": { | |
| "$ref": "#/components/schemas/shopify_local_cart_item_metadata" | |
| }, | |
| "gift_card": { | |
| "type": "boolean" | |
| }, | |
| "image": { | |
| "type": "string" | |
| }, | |
| "product_description": { | |
| "type": "string" | |
| }, | |
| "product_type": { | |
| "type": "string" | |
| }, | |
| "requires_shipping": { | |
| "type": "boolean" | |
| }, | |
| "sku": { | |
| "type": "string" | |
| }, | |
| "variant_title": { | |
| "type": "string" | |
| }, | |
| "variant_options": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "vendor": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_customer_metafield_value": { | |
| "description": "Model to represent details available in a customer metafield.", | |
| "properties": { | |
| "flow_consumer_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_item_event_bucket": { | |
| "properties": { | |
| "range": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| }, | |
| "count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/shopify_item_event_data" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_item_event_data": { | |
| "properties": { | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_reference" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/catalog_item_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_line": { | |
| "properties": { | |
| "variant_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/shopify_price" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/shopify_price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_local_cart_item_metadata": { | |
| "properties": { | |
| "line_price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_local_cart_metadata": { | |
| "properties": { | |
| "total_price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "promotions": { | |
| "$ref": "#/components/schemas/promotions" | |
| }, | |
| "rules": { | |
| "$ref": "#/components/schemas/order_rules_summary" | |
| }, | |
| "subtotal": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "vat": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| }, | |
| "discount": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_local_price_metadata": { | |
| "properties": { | |
| "price": { | |
| "$ref": "#/components/schemas/price_with_base" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_localization_setting": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "method": { | |
| "$ref": "#/components/schemas/shopify_localization_method" | |
| }, | |
| "datetime_range": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_localization_setting_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "shopify_localization_setting": { | |
| "$ref": "#/components/schemas/shopify_localization_setting" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_localization_setting_form": { | |
| "properties": { | |
| "method": { | |
| "$ref": "#/components/schemas/shopify_localization_method" | |
| }, | |
| "datetime_range": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_localization_setting_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization_id": { | |
| "type": "string" | |
| }, | |
| "shopify_localization_setting": { | |
| "$ref": "#/components/schemas/shopify_localization_setting" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_localized_order": { | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "lines": { | |
| "items": { | |
| "$ref": "#/components/schemas/shopify_line" | |
| }, | |
| "type": "array" | |
| }, | |
| "prices": { | |
| "items": { | |
| "$ref": "#/components/schemas/shopify_price" | |
| }, | |
| "type": "array" | |
| }, | |
| "total": { | |
| "$ref": "#/components/schemas/shopify_price" | |
| }, | |
| "allocation_details": { | |
| "items": { | |
| "$ref": "#/components/schemas/allocation_detail" | |
| }, | |
| "type": "array" | |
| }, | |
| "merchant_of_record": { | |
| "$ref": "#/components/schemas/order_merchant_of_record" | |
| }, | |
| "merchant_of_record_entity": { | |
| "$ref": "#/components/schemas/merchant_of_record_entity" | |
| }, | |
| "incoterm": { | |
| "$ref": "#/components/schemas/incoterm" | |
| }, | |
| "flow_order_id": { | |
| "type": "string" | |
| }, | |
| "tax_registration": { | |
| "$ref": "#/components/schemas/tax_registration" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_localized_variant": { | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "handle": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_reference" | |
| }, | |
| "prices": { | |
| "$ref": "#/components/schemas/shopify_localized_variant_prices" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/subcatalog_item_status" | |
| }, | |
| "inventory_status": { | |
| "$ref": "#/components/schemas/item_availability_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_localized_variant_prices": { | |
| "properties": { | |
| "item": { | |
| "$ref": "#/components/schemas/shopify_price" | |
| }, | |
| "compare_at": { | |
| "$ref": "#/components/schemas/shopify_price" | |
| }, | |
| "vat": { | |
| "$ref": "#/components/schemas/shopify_price" | |
| }, | |
| "duty": { | |
| "$ref": "#/components/schemas/shopify_price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_location_flow_center_mapping": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "shopify_location": { | |
| "$ref": "#/components/schemas/shopify_location_reference" | |
| }, | |
| "flow_center": { | |
| "$ref": "#/components/schemas/flow_center_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_location_flow_center_mapping_form": { | |
| "properties": { | |
| "shopify_location_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "flow_center_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_location_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_order_attributes_form": { | |
| "properties": {}, | |
| "type": "object" | |
| }, | |
| "shopify_order_delivery_metafield": { | |
| "description": "Model to represent a delivery metafield", | |
| "properties": { | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/shopify_order_delivery_metafield_item" | |
| }, | |
| "type": "array" | |
| }, | |
| "service": { | |
| "$ref": "#/components/schemas/service_summary" | |
| }, | |
| "window": { | |
| "$ref": "#/components/schemas/delivery_window" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_order_delivery_metafield_item": { | |
| "description": "Model to represent a delivery metafield", | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_order_price_attributes_metafield": { | |
| "description": "Model to represent item's price attributes metafield", | |
| "properties": { | |
| "item_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_order_romanization_metafield": { | |
| "description": "Model to represent romanized order detail metafield", | |
| "properties": { | |
| "destination": { | |
| "$ref": "#/components/schemas/order_address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_price": { | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "cents": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "includes": { | |
| "$ref": "#/components/schemas/included_levies" | |
| }, | |
| "local": { | |
| "$ref": "#/components/schemas/shopify_local_price_metadata" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_private_app": { | |
| "description": "Shopify private app information.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "api_key": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_private_app_form": { | |
| "properties": { | |
| "api_key": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_sync_status": { | |
| "properties": { | |
| "sync_check": { | |
| "$ref": "#/components/schemas/shopify_sync_check" | |
| }, | |
| "range": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| }, | |
| "interval_seconds": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "buckets": { | |
| "items": { | |
| "$ref": "#/components/schemas/shopify_event_bucket" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_variant_flow_metafield": { | |
| "description": "The shopify variant metafield defines the individual metafield values we write into Shopify for each variant. This model was introduced to enable server side rendering of content (e.g. the price on the product detail page). Each field in this model is available as its own metafield within a namespace named 'price_abc' where abc is a unique, short identifier for an experience.", | |
| "properties": { | |
| "prices_item": { | |
| "type": "string" | |
| }, | |
| "prices_currency": { | |
| "type": "string" | |
| }, | |
| "prices_includes": { | |
| "type": "string" | |
| }, | |
| "prices_vat": { | |
| "type": "string" | |
| }, | |
| "prices_vat_name": { | |
| "type": "string" | |
| }, | |
| "prices_duty": { | |
| "type": "string" | |
| }, | |
| "prices_compare_at": { | |
| "type": "string" | |
| }, | |
| "prices_status": { | |
| "$ref": "#/components/schemas/subcatalog_item_status" | |
| }, | |
| "inventory_status": { | |
| "$ref": "#/components/schemas/item_availability_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "shopify_variant_inventory_metafield": { | |
| "description": "For enabled organizations, this indicates the total number of available units of inventory for customers in this experience.", | |
| "properties": { | |
| "experience": { | |
| "$ref": "#/components/schemas/experience_reference" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/item_availability_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "simple_permission_check": { | |
| "description": "A simple model, used to convey permitted behaviors along with approval of a request for a specific permitted route.", | |
| "properties": { | |
| "behaviors": { | |
| "items": { | |
| "$ref": "#/components/schemas/flow_behavior" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "single_package_shipping_notification_form": { | |
| "description": "Simplified form for notifying Flow of a Fulfillment shipped entirely in a single tracked package.", | |
| "properties": { | |
| "fulfillment_key": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "package_dimensions": { | |
| "$ref": "#/components/schemas/dimension" | |
| }, | |
| "service": { | |
| "type": "string" | |
| }, | |
| "shipment_recipient": { | |
| "$ref": "#/components/schemas/shipment_recipient" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "snapshot_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "snapshot_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "snapshot_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "snapshot_id": { | |
| "type": "string" | |
| }, | |
| "available": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "center_key": { | |
| "type": "string" | |
| }, | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "solidus_product_export_type": { | |
| "description": "Exports product level data for import into solidus", | |
| "properties": { | |
| "numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "sort": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "solidus_variant_export_type": { | |
| "description": "Exports variant level data for import into solidus", | |
| "properties": { | |
| "numbers": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "sort": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "stripe_authentication_data": { | |
| "description": "Stripe authentication data.", | |
| "properties": { | |
| "secret_key_reference": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "stripe_authentication_data_form": { | |
| "description": "Used to specify Stripe API secret key.", | |
| "properties": { | |
| "account_id": { | |
| "type": "string" | |
| }, | |
| "secret_key": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog": { | |
| "description": "A configuration with custom query to select a subset of master catalog items for a localized experience", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "$ref": "#/components/schemas/catalog" | |
| }, | |
| "settings": { | |
| "$ref": "#/components/schemas/subcatalog_settings" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "type": "string" | |
| }, | |
| "subcatalog_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_form": { | |
| "properties": { | |
| "settings": { | |
| "$ref": "#/components/schemas/subcatalog_settings_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_item": { | |
| "description": "Represents information specific to an item in a given subcatalog", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "item": { | |
| "$ref": "#/components/schemas/item" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/subcatalog_item_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_item_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "type": "string" | |
| }, | |
| "subcatalog_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_item_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "type": "string" | |
| }, | |
| "subcatalog_id": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_item_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "subcatalog_item": { | |
| "$ref": "#/components/schemas/subcatalog_item" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_query": { | |
| "description": "Represents a typed query to indicate which items to include or exclude in a subcatalog", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "q": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/query_type" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_query_form": { | |
| "description": "Defines a query specifying items to be included or excluded in a subcatalog", | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/query_type" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_query_validation": { | |
| "description": "Indicates valid and invalid queries", | |
| "properties": { | |
| "valid": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "invalid": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_settings": { | |
| "properties": { | |
| "update_policy": { | |
| "$ref": "#/components/schemas/update_policy" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_settings_form": { | |
| "properties": { | |
| "update_policy": { | |
| "$ref": "#/components/schemas/update_policy" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_statistics": { | |
| "description": "Statistics related to the items in this subcatalog, including item count, number of distinct categories, etc.", | |
| "properties": { | |
| "excluded": { | |
| "$ref": "#/components/schemas/item_statistics" | |
| }, | |
| "included": { | |
| "$ref": "#/components/schemas/item_statistics" | |
| }, | |
| "restricted": { | |
| "$ref": "#/components/schemas/item_statistics" | |
| }, | |
| "queue": { | |
| "$ref": "#/components/schemas/item_statistics" | |
| }, | |
| "catalog": { | |
| "$ref": "#/components/schemas/catalog_statistics" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "type": "string" | |
| }, | |
| "subcatalog_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "subcatalog_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "subcatalog": { | |
| "$ref": "#/components/schemas/subcatalog" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "suggestion": { | |
| "properties": { | |
| "label": { | |
| "type": "string" | |
| }, | |
| "count": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "summary_shipping_label_form": { | |
| "description": "Minimal form to create a shipping label. Origin and destination are assumed based on a given order's center and final shipping destination", | |
| "properties": { | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/line_item_form" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "surcharge_responsible_party_display": { | |
| "description": "Surcharge responsible parties that can be displayed and selected", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "responsible_party": { | |
| "$ref": "#/components/schemas/surcharge_responsible_party" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "surcharge_setting": { | |
| "properties": { | |
| "key": { | |
| "$ref": "#/components/schemas/delivery_option_cost_detail_component_key" | |
| }, | |
| "responsible_party": { | |
| "$ref": "#/components/schemas/surcharge_responsible_party" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "surcharge_setting_display": { | |
| "description": "Surcharge settings that can be displayed and configured", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "$ref": "#/components/schemas/delivery_option_cost_detail_component_key" | |
| }, | |
| "available": { | |
| "items": { | |
| "$ref": "#/components/schemas/surcharge_responsible_party_display" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "queries": { | |
| "items": { | |
| "$ref": "#/components/schemas/targeting_query" | |
| }, | |
| "type": "array" | |
| }, | |
| "catalog": { | |
| "$ref": "#/components/schemas/catalog_reference" | |
| }, | |
| "subcatalog": { | |
| "$ref": "#/components/schemas/subcatalog_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_form": { | |
| "properties": { | |
| "key": { | |
| "type": "string" | |
| }, | |
| "queries": { | |
| "items": { | |
| "$ref": "#/components/schemas/targeting_query_form" | |
| }, | |
| "type": "array" | |
| }, | |
| "subcatalog_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_item": { | |
| "description": "Represents catalog items where a targeting query is applicable", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "targeting": { | |
| "$ref": "#/components/schemas/targeting_summary" | |
| }, | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "query": { | |
| "$ref": "#/components/schemas/targeting_query" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_item_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_item_deleted_v3": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_item_upserted": { | |
| "description": "Indiciates that a given item has been targeted by the query q producing an outcome. The item number is unique within its targeting_id.", | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "targeting_id": { | |
| "type": "string" | |
| }, | |
| "item_number": { | |
| "type": "string" | |
| }, | |
| "q": { | |
| "type": "string" | |
| }, | |
| "outcome_id": { | |
| "type": "string" | |
| }, | |
| "catalog_id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "subcatalog_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_item_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "targeting_item": { | |
| "$ref": "#/components/schemas/targeting_item" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_query": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "q": { | |
| "type": "string" | |
| }, | |
| "outcome_id": { | |
| "type": "string" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_query_form": { | |
| "properties": { | |
| "q": { | |
| "type": "string" | |
| }, | |
| "outcome_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "catalog": { | |
| "$ref": "#/components/schemas/catalog_reference" | |
| }, | |
| "subcatalog": { | |
| "$ref": "#/components/schemas/subcatalog_reference" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "targeting_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "targeting": { | |
| "$ref": "#/components/schemas/targeting" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tariff_code": { | |
| "description": "Harmonized System codes for specific products imported into specific countries. These are between 4 and 12 digits and are used to select the correct duty rate.", | |
| "properties": { | |
| "code": { | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tax": { | |
| "description": "Represents a simple model of taxes that apply to a given item / destination.", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "rate": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "components": { | |
| "items": { | |
| "$ref": "#/components/schemas/levy_component" | |
| }, | |
| "type": "array" | |
| }, | |
| "deminimis": { | |
| "$ref": "#/components/schemas/deminimis" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tax_registration": { | |
| "description": "Result of looking up a specific tax registration number. Indicates validity of a number for a specific country and (if valid) the associated person/company.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "result": { | |
| "$ref": "#/components/schemas/tax_verification_result" | |
| }, | |
| "result_reason": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "type": "string" | |
| }, | |
| "company_name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tax_registration_form": { | |
| "properties": { | |
| "number": { | |
| "type": "string" | |
| }, | |
| "company_name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "three_d_secure": { | |
| "description": "Represents the results from 3D Secure, if applied to an authorization", | |
| "properties": { | |
| "code": { | |
| "$ref": "#/components/schemas/three_d_secure_code" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier": { | |
| "description": "Service shipping tier available in this tier group. e.g. Standard tier, Express tier, Economy tier", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "direction": { | |
| "$ref": "#/components/schemas/tier_direction" | |
| }, | |
| "integration": { | |
| "$ref": "#/components/schemas/shipment_integration_type" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "rules": { | |
| "items": { | |
| "$ref": "#/components/schemas/tier_rule" | |
| }, | |
| "type": "array" | |
| }, | |
| "services": { | |
| "items": { | |
| "$ref": "#/components/schemas/carrier_service" | |
| }, | |
| "type": "array" | |
| }, | |
| "strategy": { | |
| "$ref": "#/components/schemas/tier_strategy" | |
| }, | |
| "visibility": { | |
| "$ref": "#/components/schemas/visibility" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "display": { | |
| "$ref": "#/components/schemas/tier_display" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/fulfillment_experience_reference" | |
| }, | |
| "shipping_lane": { | |
| "type": "string" | |
| }, | |
| "surcharge_settings": { | |
| "items": { | |
| "$ref": "#/components/schemas/surcharge_setting" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_deleted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "tier": { | |
| "$ref": "#/components/schemas/tier" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_display": { | |
| "properties": { | |
| "estimate": { | |
| "$ref": "#/components/schemas/tier_estimate" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_display_form": { | |
| "properties": { | |
| "estimate": { | |
| "$ref": "#/components/schemas/tier_estimate" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_estimate": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/tier_estimate_type" | |
| }, | |
| "label": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_form": { | |
| "description": "Service shipping tier available in this tier group. e.g. Standard tier, Express tier, Economy tier", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "integration": { | |
| "$ref": "#/components/schemas/shipment_integration_type" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "rules": { | |
| "items": { | |
| "$ref": "#/components/schemas/tier_rule_form" | |
| }, | |
| "type": "array" | |
| }, | |
| "services": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "strategy": { | |
| "$ref": "#/components/schemas/tier_strategy" | |
| }, | |
| "visibility": { | |
| "$ref": "#/components/schemas/visibility" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "direction": { | |
| "$ref": "#/components/schemas/tier_direction" | |
| }, | |
| "display": { | |
| "$ref": "#/components/schemas/tier_display_form" | |
| }, | |
| "experience": { | |
| "type": "string" | |
| }, | |
| "shipping_lane": { | |
| "type": "string" | |
| }, | |
| "surcharge_settings": { | |
| "items": { | |
| "$ref": "#/components/schemas/surcharge_setting" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_rule": { | |
| "description": "System to filter incoming quote for a shipment request based on a query and output corresponding outcomes.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "query": { | |
| "type": "string" | |
| }, | |
| "outcome": { | |
| "$ref": "#/components/schemas/tier_rule_outcome" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_rule_form": { | |
| "properties": { | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "query": { | |
| "type": "string" | |
| }, | |
| "outcome": { | |
| "$ref": "#/components/schemas/tier_rule_outcome_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_rule_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "tier_rule": { | |
| "$ref": "#/components/schemas/tier_rule" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "experience": { | |
| "$ref": "#/components/schemas/fulfillment_experience_reference" | |
| }, | |
| "integration": { | |
| "$ref": "#/components/schemas/shipment_integration_type" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "services": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "strategy": { | |
| "$ref": "#/components/schemas/tier_strategy" | |
| }, | |
| "visibility": { | |
| "$ref": "#/components/schemas/visibility" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "display": { | |
| "$ref": "#/components/schemas/tier_display" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_upserted_v2": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "tier": { | |
| "$ref": "#/components/schemas/tier" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tier_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "tier": { | |
| "$ref": "#/components/schemas/tier_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "timezone": { | |
| "description": "Time zone data is provided by the public IANA time zone database. See http://www.iana.org/time-zones", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "offset": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "token_authentication_form": { | |
| "description": "Used to authenticate a given token.", | |
| "properties": { | |
| "token": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "token_partner_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "token_validation": { | |
| "description": "Model used to report whether or not a given token is valid", | |
| "properties": { | |
| "status": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "token_validation_form": { | |
| "description": "Defines the payload of a request to validate a token, with primary goal of preventing the token from being included in an HTTP GET.", | |
| "properties": { | |
| "token": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking": { | |
| "description": "Top level tracking information which contains labels. In cases where shipments are re-labeled, you will see multiple labels for each tracking allowing simple access to see where a shipment is - with which carrier and with the local tracking number", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "labels": { | |
| "items": { | |
| "$ref": "#/components/schemas/tracking_label" | |
| }, | |
| "type": "array" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/tracking_status" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "window": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_event": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/tracking_status" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_event_form": { | |
| "properties": { | |
| "tracking_label_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/tracking_status" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_event_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/tracking_status" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_event_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "tracking_event": { | |
| "$ref": "#/components/schemas/tracking_event_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_form": { | |
| "description": "Top level tracking information which contains labels. In cases where shipments are re-labeled, you will see multiple labels for each tracking allowing simple access to see where a shipment is - with which carrier and with the local tracking number", | |
| "properties": { | |
| "status": { | |
| "$ref": "#/components/schemas/tracking_status" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| }, | |
| "window": { | |
| "$ref": "#/components/schemas/datetime_range" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_label": { | |
| "description": "Represents a specific label being tracked as part of the tracking bucket", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "carrier": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "events": { | |
| "items": { | |
| "$ref": "#/components/schemas/tracking_event" | |
| }, | |
| "type": "array" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/tracking_status" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "delivery_estimate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_label_event_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "$ref": "#/components/schemas/address" | |
| }, | |
| "carrier": { | |
| "type": "string" | |
| }, | |
| "carrier_timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "flow_tracking_number": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| }, | |
| "delivery_estimate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_label_form": { | |
| "description": "Represents a specific label being tracked as part of the tracking bucket", | |
| "properties": { | |
| "tracking_id": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/tracking_status" | |
| }, | |
| "carrier": { | |
| "type": "string" | |
| }, | |
| "carrier_tracking_number": { | |
| "type": "string" | |
| }, | |
| "delivery_estimate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "parent_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_label_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "tracking": { | |
| "$ref": "#/components/schemas/tracking_summary" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/tracking_status" | |
| }, | |
| "carrier": { | |
| "type": "string" | |
| }, | |
| "tracking_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_label_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "tracking_label": { | |
| "$ref": "#/components/schemas/tracking_label_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_summary": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/tracking_status" | |
| }, | |
| "order_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "tracking_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "tracking": { | |
| "$ref": "#/components/schemas/tracking_summary" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "transit_estimate": { | |
| "properties": { | |
| "origin": { | |
| "$ref": "#/components/schemas/delivery_window_location" | |
| }, | |
| "destination": { | |
| "$ref": "#/components/schemas/delivery_window_location" | |
| }, | |
| "min_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "max_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/delivery_window_component_source" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "transit_window": { | |
| "properties": { | |
| "origin_country": { | |
| "type": "string" | |
| }, | |
| "destination_country": { | |
| "type": "string" | |
| }, | |
| "from": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "to": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "unharmonized_item_export_type": { | |
| "description": "Export for items that require harmonization.", | |
| "properties": { | |
| "sort": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "upload": { | |
| "description": "Provides the ability to upload a file to a URL (an expiring s3 url, usually valid for 1 week)", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "expiration": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "user": { | |
| "description": "Represents a single user in the system", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "$ref": "#/components/schemas/name" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/user_status" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "user_form": { | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "$ref": "#/components/schemas/name_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "user_put_form": { | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "$ref": "#/components/schemas/name_form" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "user_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "user_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/user" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "value_threshold_exceeded_details": { | |
| "properties": { | |
| "local": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "original": { | |
| "$ref": "#/components/schemas/price" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card": { | |
| "description": "Virtual card details", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "number": { | |
| "type": "string" | |
| }, | |
| "cvv": { | |
| "type": "string" | |
| }, | |
| "limit": { | |
| "$ref": "#/components/schemas/price" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/card_type" | |
| }, | |
| "expiration": { | |
| "$ref": "#/components/schemas/expiration" | |
| }, | |
| "iin": { | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_capture": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "$ref": "#/components/schemas/issuer_v1" | |
| }, | |
| "virtual_card": { | |
| "$ref": "#/components/schemas/virtual_card_reference" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/authorization_reference" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_capture_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_capture_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "capture": { | |
| "$ref": "#/components/schemas/virtual_card_capture" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_capture_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "virtual_card_capture": { | |
| "$ref": "#/components/schemas/virtual_card_capture" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_form": { | |
| "properties": { | |
| "limit": { | |
| "$ref": "#/components/schemas/money" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_refund": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "$ref": "#/components/schemas/issuer_v1" | |
| }, | |
| "virtual_card": { | |
| "$ref": "#/components/schemas/virtual_card_reference" | |
| }, | |
| "authorization": { | |
| "$ref": "#/components/schemas/authorization_reference" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_refund_deleted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_refund_upserted": { | |
| "properties": { | |
| "event_id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "organization": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "refund": { | |
| "$ref": "#/components/schemas/virtual_card_refund" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_refund_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "virtual_card_refund": { | |
| "$ref": "#/components/schemas/virtual_card_refund" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "virtual_card_version": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/change_type" | |
| }, | |
| "virtual_card": { | |
| "$ref": "#/components/schemas/virtual_card" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "webhook": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "events": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "webhook_delivery": { | |
| "description": "A webhook delivery represents an event that matched a webhook's event types. Each delivery will be attempted one or more times subject to the settings of your webhook.", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "webhook": { | |
| "$ref": "#/components/schemas/webhook_reference" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/webhook_status" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "latest": { | |
| "$ref": "#/components/schemas/webhook_request" | |
| }, | |
| "next_attempt_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "webhook_form": { | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "events": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "webhook_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "webhook_request": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "items": { | |
| "$ref": "#/components/schemas/header" | |
| }, | |
| "type": "array" | |
| }, | |
| "method": { | |
| "$ref": "#/components/schemas/method" | |
| }, | |
| "body": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/components/schemas/webhook_status" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "completed_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "duration_ms": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "response": { | |
| "$ref": "#/components/schemas/webhook_response" | |
| }, | |
| "error": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "webhook_request_reference": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "webhook_response": { | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "request": { | |
| "$ref": "#/components/schemas/webhook_request_reference" | |
| }, | |
| "headers": { | |
| "items": { | |
| "$ref": "#/components/schemas/header" | |
| }, | |
| "type": "array" | |
| }, | |
| "body": { | |
| "type": "string" | |
| }, | |
| "body_url": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "webhook_settings": { | |
| "description": "Sets organization level settings to determine things like how many retries on delivery, how long we wait, etc. By default, we will attempt delivery up to 6 times, using exponential backoff with a see of 1 minute (60k ms) - which means that we will retry over the course of approximately an hour before giving up.", | |
| "properties": { | |
| "secret": { | |
| "type": "string" | |
| }, | |
| "retry_max_attempts": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "retry_sleep_ms": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "sleep_ms": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "zone": { | |
| "properties": { | |
| "postals": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "provinces": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "country": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "adjustment_reason_key": { | |
| "description": "The key of each possible adjustment is defined here.", | |
| "enum": ["duty_deminimis", "vat_deminimis"], | |
| "type": "string" | |
| }, | |
| "aggregate": { | |
| "description": "The aggregate function to be applied", | |
| "enum": ["maximum", "minimum"], | |
| "type": "string" | |
| }, | |
| "attribute_data_type": { | |
| "description": "Used to tag attributes with a data type so they are properly validated.", | |
| "enum": ["boolean", "decimal", "string"], | |
| "type": "string" | |
| }, | |
| "attribute_intent": { | |
| "description": "Used to tag attributes as having a specific meaning that can affect processing. For example, if you have an attribute called \"brandname\", and assign it the \"brand\" intent, the value of the \"brandname\" attribute will be used where a brand name is needed. Note that an intent can be assigned to any amount of attributes of an item.", | |
| "enum": [ | |
| "brand", | |
| "color", | |
| "countries_of_origin", | |
| "product_id", | |
| "fulfillment_method", | |
| "hazardous", | |
| "price", | |
| "size", | |
| "sku", | |
| "taxability", | |
| "consumer_url", | |
| "gtin", | |
| "mpn", | |
| "excluded_regions" | |
| ], | |
| "type": "string" | |
| }, | |
| "authentication_technique": { | |
| "description": "Various techniques a client request will use to authenticate with Flow.", | |
| "enum": ["anonymous", "session", "token", "partner_token", "user"], | |
| "type": "string" | |
| }, | |
| "authorization_decline_code": { | |
| "description": "Contains details related to the reason for which an authorization was declined.", | |
| "enum": [ | |
| "expired", | |
| "invalid_name", | |
| "invalid_number", | |
| "invalid_expiration", | |
| "invalid_address", | |
| "invalid_token_type", | |
| "invalid_token", | |
| "no_account", | |
| "avs", | |
| "cvv", | |
| "fraud", | |
| "duplicate", | |
| "not_supported", | |
| "unknown" | |
| ], | |
| "type": "string" | |
| }, | |
| "authorization_option": { | |
| "description": "Specifies optional behaviors that can be applied during an authorization", | |
| "enum": ["store_card"], | |
| "type": "string" | |
| }, | |
| "authorization_result_action_type": { | |
| "description": "Specifies an action necessary to continue processing the authorization, such as redirecting to a payment issuer to complete user verification.", | |
| "enum": ["redirect", "wait"], | |
| "type": "string" | |
| }, | |
| "authorization_status": { | |
| "enum": [ | |
| "pending", | |
| "expired", | |
| "authorized", | |
| "review", | |
| "declined", | |
| "reversed" | |
| ], | |
| "type": "string" | |
| }, | |
| "availability_status": { | |
| "enum": ["enabled", "disabled"], | |
| "type": "string" | |
| }, | |
| "available_filter_format": { | |
| "description": "The Available Filter Format defines the type of data that is expected in a single filter", | |
| "enum": [ | |
| "boolean", | |
| "date", | |
| "money", | |
| "decimal", | |
| "string", | |
| "unit_of_length", | |
| "unit_of_mass" | |
| ], | |
| "type": "string" | |
| }, | |
| "avs_code": { | |
| "enum": ["match", "partial", "unsupported", "no_match"], | |
| "type": "string" | |
| }, | |
| "calendar": { | |
| "enum": ["weekdays", "everyday"], | |
| "type": "string" | |
| }, | |
| "cancel_reason": { | |
| "description": "The reason for a cancellation. Choice of a reason may change how and which parties are notified about a cancel.", | |
| "enum": ["out_of_stock", "consumer_requested", "flow_cancel"], | |
| "type": "string" | |
| }, | |
| "capability": { | |
| "enum": ["crossdock"], | |
| "type": "string" | |
| }, | |
| "capture_decline_code": { | |
| "description": "Contains details related to the reason for which a capture failed.", | |
| "enum": ["expired", "insufficient_funds", "unknown"], | |
| "type": "string" | |
| }, | |
| "capture_status": { | |
| "enum": ["pending", "succeeded", "failed", "canceled"], | |
| "type": "string" | |
| }, | |
| "card_error_code": { | |
| "enum": [ | |
| "invalid_address", | |
| "invalid_name", | |
| "invalid_number", | |
| "invalid_expiration", | |
| "invalid_token_type", | |
| "avs", | |
| "cvv", | |
| "fraud", | |
| "unknown" | |
| ], | |
| "type": "string" | |
| }, | |
| "card_type": { | |
| "enum": [ | |
| "american_express", | |
| "cartes_bancaires", | |
| "china_union_pay", | |
| "dankort", | |
| "diners_club", | |
| "discover", | |
| "jcb", | |
| "maestro", | |
| "mastercard", | |
| "visa" | |
| ], | |
| "type": "string" | |
| }, | |
| "center_capability": { | |
| "enum": [ | |
| "international", | |
| "domestic", | |
| "crossdock", | |
| "commercial_invoice" | |
| ], | |
| "type": "string" | |
| }, | |
| "change_type": { | |
| "enum": ["insert", "update", "delete"], | |
| "type": "string" | |
| }, | |
| "consumer_invoice_customer_type": { | |
| "enum": ["business_eu_verified", "business_non_verified", "individual"], | |
| "type": "string" | |
| }, | |
| "consumer_invoice_document_type": { | |
| "description": "The invoice content type defines the type of content contained in a given url", | |
| "enum": ["pdf"], | |
| "type": "string" | |
| }, | |
| "consumer_invoice_status": { | |
| "enum": ["pending", "available", "invalid"], | |
| "type": "string" | |
| }, | |
| "credit_payment_error_code": { | |
| "enum": [ | |
| "generic_error", | |
| "invalid_order_number", | |
| "invalid_currency", | |
| "invalid_description", | |
| "duplicate", | |
| "amount_must_be_positive", | |
| "amount_exceeds_balance", | |
| "insufficient_amount" | |
| ], | |
| "type": "string" | |
| }, | |
| "currency_label_formatter": { | |
| "description": "A currency label formatter accepts a price label and updates it according to a set of rules.", | |
| "enum": ["strip_trailing_zeros"], | |
| "type": "string" | |
| }, | |
| "currency_symbol_format": { | |
| "description": "The currency symbol format controls which set of currency symbols we use when displaying currencies", | |
| "enum": ["narrow", "primary"], | |
| "type": "string" | |
| }, | |
| "cvv_code": { | |
| "enum": ["match", "suspicious", "unsupported", "no_match"], | |
| "type": "string" | |
| }, | |
| "day_of_week": { | |
| "enum": [ | |
| "sunday", | |
| "monday", | |
| "tuesday", | |
| "wednesday", | |
| "thursday", | |
| "friday", | |
| "saturday" | |
| ], | |
| "type": "string" | |
| }, | |
| "delivered_duty": { | |
| "enum": ["paid", "unpaid"], | |
| "type": "string" | |
| }, | |
| "delivered_duty_display_type": { | |
| "enum": ["all", "single"], | |
| "type": "string" | |
| }, | |
| "delivery_option_cost_detail_component_key": { | |
| "enum": [ | |
| "ratecard_base_cost", | |
| "ratecard_ddp_fee", | |
| "ratecard_fuel_surcharge", | |
| "ratecard_oversized_shipment_fee", | |
| "ratecard_rural_shipment_fee", | |
| "center_commercial_invoice_fee", | |
| "center_inbound_carton_fee", | |
| "center_outbound_carton_fee" | |
| ], | |
| "type": "string" | |
| }, | |
| "delivery_option_cost_detail_source": { | |
| "enum": ["center", "ratecard"], | |
| "type": "string" | |
| }, | |
| "delivery_window_component_source": { | |
| "enum": ["flow", "organization", "carrier", "center", "mixed"], | |
| "type": "string" | |
| }, | |
| "delivery_window_location": { | |
| "enum": ["center", "crossdock", "customer"], | |
| "type": "string" | |
| }, | |
| "direction": { | |
| "enum": ["outbound", "return"], | |
| "type": "string" | |
| }, | |
| "economic_title_location": { | |
| "enum": ["high_seas", "origination", "destination"], | |
| "type": "string" | |
| }, | |
| "environment": { | |
| "enum": ["sandbox", "production"], | |
| "type": "string" | |
| }, | |
| "event_type": { | |
| "enum": [ | |
| "attribute_upserted", | |
| "attribute_deleted", | |
| "attribute_upserted_v2", | |
| "attribute_deleted_v2", | |
| "catalog_upserted", | |
| "catalog_deleted", | |
| "subcatalog_upserted", | |
| "subcatalog_deleted", | |
| "catalog_item_upserted", | |
| "catalog_item_deleted", | |
| "catalog_item_upserted_v2", | |
| "catalog_item_deleted_v2", | |
| "subcatalog_item_upserted", | |
| "subcatalog_item_deleted", | |
| "b2b_invoice_upserted", | |
| "b2b_invoice_deleted", | |
| "consumer_invoice_upserted", | |
| "consumer_invoice_deleted", | |
| "credit_memo_upserted", | |
| "credit_memo_deleted", | |
| "crossdock_shipment_upserted", | |
| "rate_deleted", | |
| "rate_upserted", | |
| "available_promotions_upserted", | |
| "available_promotions_deleted", | |
| "available_promotions_upserted_v2", | |
| "available_promotions_deleted_v2", | |
| "allocation_deleted_v2", | |
| "allocation_upserted_v2", | |
| "currency_format_deleted", | |
| "currency_format_upserted", | |
| "experience_deleted", | |
| "experience_upserted", | |
| "experience_deleted_v2", | |
| "experience_upserted_v2", | |
| "experience_price_book_mapping_deleted", | |
| "experience_price_book_mapping_upserted", | |
| "experience_logistics_settings_upserted", | |
| "experience_logistics_settings_deleted", | |
| "item_margin_deleted", | |
| "item_margin_upserted", | |
| "item_sales_margin_deleted", | |
| "item_sales_margin_upserted", | |
| "label_format_deleted", | |
| "label_format_upserted", | |
| "order_deleted", | |
| "order_upserted", | |
| "order_deleted_v2", | |
| "order_upserted_v2", | |
| "order_identifier_deleted", | |
| "order_identifier_upserted", | |
| "order_identifier_deleted_v2", | |
| "order_identifier_upserted_v2", | |
| "pricing_deleted", | |
| "pricing_upserted", | |
| "fraud_status_changed", | |
| "center_upserted", | |
| "center_deleted", | |
| "delivery_option_upserted", | |
| "delivery_option_deleted", | |
| "shipping_configuration_upserted", | |
| "shipping_configuration_deleted", | |
| "tier_upserted_v2", | |
| "tier_deleted_v2", | |
| "shipping_lane_upserted", | |
| "shipping_lane_deleted", | |
| "shipping_configuration_item_availability_upserted", | |
| "shipping_configuration_item_availability_deleted", | |
| "hs6_code_upserted", | |
| "hs6_code_deleted", | |
| "hs10_code_upserted", | |
| "hs10_code_deleted", | |
| "item_origin_upserted", | |
| "item_origin_deleted", | |
| "harmonized_item_upserted", | |
| "harmonized_item_deleted", | |
| "harmonized_landed_cost_upserted", | |
| "fully_harmonized_item_upserted", | |
| "rule_upserted", | |
| "rule_deleted", | |
| "serial_upserted", | |
| "serial_deleted", | |
| "snapshot_upserted", | |
| "snapshot_deleted", | |
| "label_upserted", | |
| "notification_upserted", | |
| "notification_deleted", | |
| "manifested_label_upserted", | |
| "manifested_label_deleted", | |
| "local_item_upserted", | |
| "local_item_deleted", | |
| "checkout_optin_responses_upserted", | |
| "checkout_optin_responses_deleted", | |
| "browse_optin_responses_upserted", | |
| "browse_optin_responses_deleted", | |
| "order_placed", | |
| "ready_to_fulfill", | |
| "membership_upserted_v2", | |
| "membership_deleted_v2", | |
| "organization_upserted", | |
| "organization_deleted", | |
| "organization_upserted_v2", | |
| "organization_deleted_v2", | |
| "organization_short_id_upserted", | |
| "organization_short_id_deleted", | |
| "authorization_deleted_v2", | |
| "authorization_status_changed", | |
| "card_authorization_upserted_v2", | |
| "card_authorization_deleted_v2", | |
| "online_authorization_upserted_v2", | |
| "online_authorization_deleted_v2", | |
| "capture_upserted_v2", | |
| "capture_deleted", | |
| "card_upserted_v2", | |
| "card_deleted", | |
| "payment_upserted", | |
| "payment_deleted", | |
| "refund_upserted_v2", | |
| "refund_deleted_v2", | |
| "refund_capture_upserted_v2", | |
| "reversal_upserted", | |
| "reversal_deleted", | |
| "capture_identifier_upserted", | |
| "capture_identifier_deleted", | |
| "refund_identifier_upserted", | |
| "refund_identifier_deleted", | |
| "virtual_card_capture_upserted", | |
| "virtual_card_capture_deleted", | |
| "virtual_card_refund_upserted", | |
| "virtual_card_refund_deleted", | |
| "price_book_upserted", | |
| "price_book_deleted", | |
| "price_book_item_upserted", | |
| "price_book_item_deleted", | |
| "organization_rates_published", | |
| "organization_countries_published", | |
| "return_upserted", | |
| "return_deleted", | |
| "shopify_localization_setting_upserted", | |
| "shopify_localization_setting_deleted", | |
| "targeting_item_upserted", | |
| "targeting_item_upserted_v2", | |
| "targeting_item_deleted", | |
| "targeting_item_deleted_v3", | |
| "tracking_label_event_upserted" | |
| ], | |
| "type": "string" | |
| }, | |
| "exception_type": { | |
| "enum": ["open", "closed"], | |
| "type": "string" | |
| }, | |
| "experience_payment_method_tag": { | |
| "enum": ["display"], | |
| "type": "string" | |
| }, | |
| "experience_status": { | |
| "enum": ["draft", "active", "archiving", "archived"], | |
| "type": "string" | |
| }, | |
| "export_status": { | |
| "description": "Export status is a finite state machine with valid transitions of created to processing, processing to completed or failed", | |
| "enum": ["created", "processing", "completed", "failed"], | |
| "type": "string" | |
| }, | |
| "flow_addon_role": { | |
| "description": "Default addon roles supported by Flow. These roles don't provide enough access to be useful on their own but convey additional responsibility to user roles.", | |
| "enum": ["consumer_data_viewer", "membership_manager"], | |
| "type": "string" | |
| }, | |
| "flow_behavior": { | |
| "description": "Behaviors represent cross-cutting concerns that may be assigned via roles and may apply to many API endpoints.", | |
| "enum": ["view_consumer_data"], | |
| "type": "string" | |
| }, | |
| "flow_field_name": { | |
| "description": "Describes the field in a Flow catalog that will be used to link to an incoming catalog feed. Failure to link an incoming feed item to a Flow catalog item will cause that item to be removed from localized feeds.", | |
| "enum": ["item-number", "sku-attribute", "product_id-attribute"], | |
| "type": "string" | |
| }, | |
| "flow_user_role": { | |
| "description": "Default user roles supported by Flow", | |
| "enum": [ | |
| "organization_admin", | |
| "organization_merchant", | |
| "organization_operations", | |
| "organization_fulfillment", | |
| "organization_marketing", | |
| "organization_finance", | |
| "flow_operations" | |
| ], | |
| "type": "string" | |
| }, | |
| "fraud_email_rule_decision": { | |
| "description": "The decision to take when applying an email rule", | |
| "enum": ["approved", "declined"], | |
| "type": "string" | |
| }, | |
| "fraud_liability": { | |
| "enum": ["flow", "organization"], | |
| "type": "string" | |
| }, | |
| "fraud_status": { | |
| "enum": ["pending", "approved", "declined", "review"], | |
| "type": "string" | |
| }, | |
| "ftp_file_source": { | |
| "enum": ["flow", "organization"], | |
| "type": "string" | |
| }, | |
| "fulfillment_item_quantity_status": { | |
| "description": "Possible fulfillment statuses for a item quantity", | |
| "enum": ["new", "shipped", "cancelled"], | |
| "type": "string" | |
| }, | |
| "fulfillment_method_type": { | |
| "description": "Used to indicate an item's fulfillment method type.", | |
| "enum": ["fulfillment_method"], | |
| "type": "string" | |
| }, | |
| "fulfillment_method_value": { | |
| "description": "Used to indicate an item's fulfillment method values.", | |
| "enum": ["digital", "physical"], | |
| "type": "string" | |
| }, | |
| "generic_error_code": { | |
| "enum": ["generic_error", "client_error", "server_error"], | |
| "type": "string" | |
| }, | |
| "holiday_calendar": { | |
| "enum": ["us_bank_holidays", "jewish_holidays"], | |
| "type": "string" | |
| }, | |
| "image_tag": { | |
| "enum": ["thumbnail", "checkout"], | |
| "type": "string" | |
| }, | |
| "import_type": { | |
| "enum": [ | |
| "harmonization_codes", | |
| "catalog_items", | |
| "price_book_items", | |
| "price_book_items_query", | |
| "customs_descriptions", | |
| "customs_description_tariffs", | |
| "item_form_overlays" | |
| ], | |
| "type": "string" | |
| }, | |
| "included_levy_key": { | |
| "description": "The key of each possible localized price note is defined here.", | |
| "enum": ["duty", "vat", "vat_and_duty", "none"], | |
| "type": "string" | |
| }, | |
| "incoming_feed_format": { | |
| "description": "Describes types of feeds that may be ingested by Flow for augmentation.", | |
| "enum": ["google-xml", "google-sheet"], | |
| "type": "string" | |
| }, | |
| "incoming_field_name": { | |
| "description": "Describes the field in an incoming catalog feed that will be used to link to a Flow catalog. Failure to link an incoming feed item to a Flow catalog item will cause that item to be removed from localized feeds.", | |
| "enum": ["id", "mpn"], | |
| "type": "string" | |
| }, | |
| "incoterm": { | |
| "description": "International Commercial Terms are a series of pre-defined commercial terms published by the International Chamber of Commerce (ICC) relating to international commercial law.", | |
| "enum": [ | |
| "EXW", | |
| "FCA", | |
| "CPT", | |
| "CIP", | |
| "DAT", | |
| "DAP", | |
| "DDP", | |
| "FAS", | |
| "FOB", | |
| "CFR", | |
| "CIF", | |
| "DAF", | |
| "DES", | |
| "DEQ", | |
| "DDU" | |
| ], | |
| "type": "string" | |
| }, | |
| "input_specification_type": { | |
| "enum": ["text", "number"], | |
| "type": "string" | |
| }, | |
| "installment_plan_payment_error_code": { | |
| "enum": [ | |
| "invalid_authorization", | |
| "invalid_authorization_amount", | |
| "invalid_installment_plan" | |
| ], | |
| "type": "string" | |
| }, | |
| "inventory_status": { | |
| "enum": ["has_inventory", "no_inventory"], | |
| "type": "string" | |
| }, | |
| "invitation_error_code": { | |
| "enum": ["expired", "invalid_email"], | |
| "type": "string" | |
| }, | |
| "item_availability_status": { | |
| "enum": ["available", "low", "out_of_stock"], | |
| "type": "string" | |
| }, | |
| "levy_component": { | |
| "enum": ["goods", "duty", "insurance", "freight", "vat"], | |
| "type": "string" | |
| }, | |
| "levy_strategy": { | |
| "enum": ["minimum", "average", "maximum"], | |
| "type": "string" | |
| }, | |
| "margin_type": { | |
| "description": "Either a fixed or percent adjustment applied to some amount.", | |
| "enum": ["fixed", "percent"], | |
| "type": "string" | |
| }, | |
| "measurement_system": { | |
| "enum": ["imperial", "metric"], | |
| "type": "string" | |
| }, | |
| "merchant_of_record": { | |
| "description": "The merchant of record enum defines who is merchant of record for a particular transaction - either Flow is serving as the merchant of record or the organization is serving as merchant of record.", | |
| "enum": ["flow", "organization"], | |
| "type": "string" | |
| }, | |
| "method": { | |
| "description": "The available methods by which we deliver each webhook event", | |
| "enum": ["post"], | |
| "type": "string" | |
| }, | |
| "optin_response_type": { | |
| "enum": ["not_shown", "opted_in", "opted_out"], | |
| "type": "string" | |
| }, | |
| "order_change_source": { | |
| "description": "The original source of a change. For example, if a retailer is cancelling on behalf of a customer request, the source is consumer, even though the merchant issues the change to Flow.", | |
| "enum": ["consumer", "retailer", "fulfillment", "flow", "carrier"], | |
| "type": "string" | |
| }, | |
| "order_error_code": { | |
| "enum": [ | |
| "generic_error", | |
| "order_item_not_available", | |
| "order_identifier_error", | |
| "authorization_invalid", | |
| "domestic_shipping_unavailable", | |
| "shipping_unavailable", | |
| "value_threshold_exceeded", | |
| "invalid_currency", | |
| "invalid_country", | |
| "invalid_region", | |
| "invalid_language", | |
| "item_out_of_stock", | |
| "gift_card_not_accepted", | |
| "total_changed" | |
| ], | |
| "type": "string" | |
| }, | |
| "order_merchant_of_record": { | |
| "description": "The order merchant of record defines who is merchant of record for a particular order. The value will be 'mixed' if you support split payments and the merchant of record differed across the individual payment transactions.", | |
| "enum": ["flow", "organization", "mixed"], | |
| "type": "string" | |
| }, | |
| "order_payment_type": { | |
| "description": "The order payment type identified the different ways a consumer may have paid for an order. The primary purpose is in displaying summary level payment information to the user; the type can then be used to know how to request additional details for each payment.", | |
| "enum": [ | |
| "card", | |
| "online", | |
| "credit", | |
| "installment_plan", | |
| "cash_on_delivery" | |
| ], | |
| "type": "string" | |
| }, | |
| "order_price_detail_component_key": { | |
| "enum": [ | |
| "adjustment", | |
| "vat_deminimis", | |
| "duty_deminimis", | |
| "duties_item_price", | |
| "duties_freight", | |
| "duties_insurance", | |
| "vat_item_price", | |
| "vat_freight", | |
| "vat_insurance", | |
| "vat_duties_item_price", | |
| "vat_duties_freight", | |
| "vat_duties_insurance", | |
| "item_price", | |
| "item_discount", | |
| "rounding", | |
| "insurance", | |
| "shipping", | |
| "order_discount", | |
| "subtotal_percent_sales_margin", | |
| "subtotal_vat_percent_sales_margin", | |
| "subtotal_duty_percent_sales_margin", | |
| "vat_subsidy", | |
| "duty_subsidy", | |
| "remote_area_surcharge", | |
| "fuel_surcharge" | |
| ], | |
| "type": "string" | |
| }, | |
| "order_price_detail_key": { | |
| "enum": [ | |
| "adjustment", | |
| "subtotal", | |
| "vat", | |
| "duty", | |
| "shipping", | |
| "insurance", | |
| "discount", | |
| "surcharges" | |
| ], | |
| "type": "string" | |
| }, | |
| "order_status": { | |
| "description": "Indicates an order's status", | |
| "enum": ["open", "submitted"], | |
| "type": "string" | |
| }, | |
| "organization_payment_method_tag": { | |
| "enum": ["deny"], | |
| "type": "string" | |
| }, | |
| "outgoing_feed_format": { | |
| "description": "Describes types of feeds that may be output by Flow along with a target service for the feed to help ensure correct product requirements.", | |
| "enum": ["facebook-xml", "google-tsv", "google-xml", "criteo-xml"], | |
| "type": "string" | |
| }, | |
| "payment_error_code": { | |
| "enum": [ | |
| "duplicate", | |
| "invalid_amount", | |
| "invalid_currency", | |
| "invalid_method", | |
| "invalid_order", | |
| "invalid_customer", | |
| "invalid_destination", | |
| "unknown" | |
| ], | |
| "type": "string" | |
| }, | |
| "payment_method_rule_content_key": { | |
| "description": "Indicates the intent of a given instance of payment method rule content.", | |
| "enum": ["description"], | |
| "type": "string" | |
| }, | |
| "payment_method_type": { | |
| "description": "The payment method type defines at a high level different user experiences that are required to accept payment of this type. By enabling a payment method type, you are specifying that you have completed the integration and all payment methods of this type become available for offer to your users.", | |
| "enum": ["card", "online", "offline"], | |
| "type": "string" | |
| }, | |
| "permitted_http_method": { | |
| "description": "List of HTTP methods for which user permissions may be applied (OPTION for example is always permitted where CORS is enabled).", | |
| "enum": ["GET", "POST", "PUT", "DELETE", "PATCH"], | |
| "type": "string" | |
| }, | |
| "physical_delivery_special_serivce": { | |
| "enum": ["cold_storage", "hazardous", "perishable"], | |
| "type": "string" | |
| }, | |
| "price_book_status": { | |
| "enum": ["draft", "published", "archived"], | |
| "type": "string" | |
| }, | |
| "price_detail_component_key": { | |
| "enum": [ | |
| "base_price", | |
| "discount", | |
| "currency_margin", | |
| "percent_item_margin", | |
| "fixed_item_margin", | |
| "duties_item_price", | |
| "duties_added_margin", | |
| "duties_rounding", | |
| "duties_deminimis", | |
| "vat_item_price", | |
| "vat_added_margin", | |
| "vat_rounding", | |
| "vat_duties_item_price", | |
| "vat_duties_added_margin", | |
| "vat_duties_rounding", | |
| "vat_deminimis", | |
| "item_price_percent_sales_margin", | |
| "margins_percent_sales_margin", | |
| "rounding_percent_sales_margin", | |
| "vat_percent_sales_margin", | |
| "vat_duty_percent_sales_margin", | |
| "duty_percent_sales_margin" | |
| ], | |
| "type": "string" | |
| }, | |
| "price_detail_key": { | |
| "enum": [ | |
| "item_price", | |
| "margins", | |
| "vat", | |
| "duty", | |
| "rounding", | |
| "adjustment" | |
| ], | |
| "type": "string" | |
| }, | |
| "pricing_levy_setting": { | |
| "enum": ["included", "displayed", "ignored"], | |
| "type": "string" | |
| }, | |
| "promotion_trigger_type": { | |
| "description": "The Promotion Trigger Type defines the conditions we evaluate when deciding if a particular promotion should be applied to an order.", | |
| "enum": ["automatic", "order_subtotal"], | |
| "type": "string" | |
| }, | |
| "province_type": { | |
| "description": "Local terminology for province", | |
| "enum": [ | |
| "city", | |
| "dependency", | |
| "district", | |
| "emirate", | |
| "entity", | |
| "municipality", | |
| "outlying_area", | |
| "parish", | |
| "province", | |
| "state", | |
| "territory", | |
| "other" | |
| ], | |
| "type": "string" | |
| }, | |
| "query_type": { | |
| "description": "Type to indicate whether query is an inclusion or exclusion", | |
| "enum": ["exclusion", "inclusion"], | |
| "type": "string" | |
| }, | |
| "quote_error_code": { | |
| "enum": ["generic_error", "items_not_available"], | |
| "type": "string" | |
| }, | |
| "rate_type": { | |
| "description": "Indicates the type of the rate", | |
| "enum": ["flow", "organization"], | |
| "type": "string" | |
| }, | |
| "refund_decline_code": { | |
| "description": "Contains details related to the reason for which a refund failed.", | |
| "enum": ["expired", "insufficient_funds", "unknown"], | |
| "type": "string" | |
| }, | |
| "refund_status": { | |
| "enum": ["pending", "succeeded", "failed", "canceled"], | |
| "type": "string" | |
| }, | |
| "return_status": { | |
| "enum": ["open", "refunded"], | |
| "type": "string" | |
| }, | |
| "reversal_error_code": { | |
| "enum": [ | |
| "amount_exceeds_balance", | |
| "authorization_declined", | |
| "authorization_expired", | |
| "invalid_authorization", | |
| "invalid_key", | |
| "invalid_amount", | |
| "invalid_currency", | |
| "no_remaining_balance", | |
| "partial_reversal_not_supported", | |
| "unknown" | |
| ], | |
| "type": "string" | |
| }, | |
| "reversal_status": { | |
| "enum": ["pending", "processed", "failed"], | |
| "type": "string" | |
| }, | |
| "role": { | |
| "description": "A user's role within an organization", | |
| "enum": ["admin", "member"], | |
| "type": "string" | |
| }, | |
| "rounding_method": { | |
| "description": "Direction to round localized price", | |
| "enum": ["up", "down", "nearest"], | |
| "type": "string" | |
| }, | |
| "rounding_type": { | |
| "description": "Rounding type determines the rule used to enforce rounding. Common rules will ensure that the final price ends w/ a given number (e.g. ends with .95) or is a multiple of some number (multiples of 5 or 10 are common).", | |
| "enum": ["pattern", "multiple"], | |
| "type": "string" | |
| }, | |
| "schedule_exception_status": { | |
| "enum": ["Open", "Closed"], | |
| "type": "string" | |
| }, | |
| "serial_status": { | |
| "description": "The states applicable to a serial", | |
| "enum": ["available", "reserved", "sold"], | |
| "type": "string" | |
| }, | |
| "shipment_integration_type": { | |
| "description": "Type of shipping integration for a given shipping tier", | |
| "enum": ["direct", "information", "preadvice"], | |
| "type": "string" | |
| }, | |
| "shipment_recipient": { | |
| "enum": ["customer", "return", "crossdock"], | |
| "type": "string" | |
| }, | |
| "shipping_configuration_type": { | |
| "enum": ["default", "variant"], | |
| "type": "string" | |
| }, | |
| "shopify_grant": { | |
| "enum": ["customer", "discount", "gift_card", "metafield", "order"], | |
| "type": "string" | |
| }, | |
| "shopify_localization_method": { | |
| "enum": ["api", "ssr"], | |
| "type": "string" | |
| }, | |
| "shopify_sync_check": { | |
| "enum": ["localized_variants", "flow_variant_metafields"], | |
| "type": "string" | |
| }, | |
| "sort_direction": { | |
| "enum": ["ascending", "descending"], | |
| "type": "string" | |
| }, | |
| "strategy": { | |
| "enum": ["range", "from", "to"], | |
| "type": "string" | |
| }, | |
| "subcatalog_item_status": { | |
| "description": "Status indicating availability of a subcatalog item in an experience.", | |
| "enum": ["excluded", "included", "restricted"], | |
| "type": "string" | |
| }, | |
| "surcharge_responsible_party": { | |
| "enum": ["organization", "customer"], | |
| "type": "string" | |
| }, | |
| "tax_applicability": { | |
| "enum": ["none", "all"], | |
| "type": "string" | |
| }, | |
| "tax_verification_result": { | |
| "enum": ["valid", "invalid", "unable_to_validate"], | |
| "type": "string" | |
| }, | |
| "taxability_type": { | |
| "enum": ["tax_rule"], | |
| "type": "string" | |
| }, | |
| "taxability_value": { | |
| "description": "Used to indicate an item's taxability.", | |
| "enum": ["exempt"], | |
| "type": "string" | |
| }, | |
| "three_d_secure_code": { | |
| "enum": ["verified", "not_verified", "failed"], | |
| "type": "string" | |
| }, | |
| "tier_direction": { | |
| "description": "Describes fulfillment direction of this logistics tier", | |
| "enum": ["outbound", "return"], | |
| "type": "string" | |
| }, | |
| "tier_estimate_type": { | |
| "description": "Describes the type of label displayed for shipping tiers.", | |
| "enum": ["calculated", "custom"], | |
| "type": "string" | |
| }, | |
| "tier_strategy": { | |
| "description": "Strategy to apply when there are multiple rates available for a tier", | |
| "enum": ["fastest", "lowest_cost"], | |
| "type": "string" | |
| }, | |
| "token_type": { | |
| "enum": ["permanent", "one_time"], | |
| "type": "string" | |
| }, | |
| "tracking_number_type": { | |
| "enum": ["flow", "carrier"], | |
| "type": "string" | |
| }, | |
| "tracking_status": { | |
| "enum": [ | |
| "label_created", | |
| "pending", | |
| "info_received", | |
| "picked_up", | |
| "in_transit", | |
| "out_for_delivery", | |
| "attempt_fail", | |
| "delivered", | |
| "exception", | |
| "returned", | |
| "expired" | |
| ], | |
| "type": "string" | |
| }, | |
| "unit_of_measurement": { | |
| "description": "Defines the units of measurement that we support. As units are added, we conform with the standard units provided by jscience as part of JSR 363 - see http://jscience.org/api/javax/measure/unit/SI.html and http://jscience.org/api/javax/measure/unit/NonSI.html", | |
| "enum": [ | |
| "millimeter", | |
| "centimeter", | |
| "inch", | |
| "foot", | |
| "cubic_inch", | |
| "cubic_meter", | |
| "gram", | |
| "kilogram", | |
| "meter", | |
| "ounce", | |
| "pound" | |
| ], | |
| "type": "string" | |
| }, | |
| "unit_of_time": { | |
| "description": "Defines the units of time that we support", | |
| "enum": ["year", "month", "week", "day", "hour", "minute"], | |
| "type": "string" | |
| }, | |
| "update_policy": { | |
| "enum": ["auto", "queue", "discard"], | |
| "type": "string" | |
| }, | |
| "update_type": { | |
| "description": "Types of updates that can be made on quantity of inventory", | |
| "enum": ["change", "set"], | |
| "type": "string" | |
| }, | |
| "user_status": { | |
| "description": "The status of the user account. Valid transitions are from pending -> active, active -> inactive, inactive -> active", | |
| "enum": ["pending", "active", "inactive"], | |
| "type": "string" | |
| }, | |
| "value_added_service": { | |
| "enum": ["Hazardous Material"], | |
| "type": "string" | |
| }, | |
| "visibility": { | |
| "enum": ["public", "private"], | |
| "type": "string" | |
| }, | |
| "webhook_status": { | |
| "enum": ["pending", "success", "failure"], | |
| "type": "string" | |
| }, | |
| "zero_amount_indicator": { | |
| "enum": ["zero", "free"], | |
| "type": "string" | |
| }, | |
| "allocation_component": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/allocation_detail_component" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/allocation_levy_component" | |
| } | |
| ] | |
| }, | |
| "allocation_detail": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/allocation_line_detail" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/allocation_order_detail" | |
| } | |
| ] | |
| }, | |
| "authorization": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/card_authorization" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/online_authorization" | |
| } | |
| ] | |
| }, | |
| "authorization_form": { | |
| "description": "Flow provides several different options for creating an authorization", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/authorization_copy_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/direct_authorization_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/merchant_of_record_authorization_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/paypal_authorization_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/redirect_authorization_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/inline_authorization_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/ach_authorization_form" | |
| } | |
| ] | |
| }, | |
| "authorization_payload_parameters": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/google_pay_authorization_payload" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/apple_pay_merchant_validation_payload" | |
| } | |
| ] | |
| }, | |
| "available_filter": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/available_filter_structured" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/available_filter_unstructured" | |
| } | |
| ] | |
| }, | |
| "confirmation_details": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/direct_debit" | |
| } | |
| ] | |
| }, | |
| "consumer_invoice_line": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/consumer_invoice_line_item" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/consumer_invoice_line_discount" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/consumer_invoice_line_shipping" | |
| } | |
| ] | |
| }, | |
| "consumer_invoice_line_form": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/consumer_invoice_line_item_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/consumer_invoice_line_discount_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/consumer_invoice_line_shipping_form" | |
| } | |
| ] | |
| }, | |
| "delivery": { | |
| "description": "A delivery represents a group of items that will be delivered together - presenting a single price and delivery time frame, where applicable, to the user. Deliveries commonly are created based on the type of item and, for physical goods, their center of origin", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/digital_delivery" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/physical_delivery" | |
| } | |
| ] | |
| }, | |
| "deminimis": { | |
| "description": "De Minimis describes the country specific rules for exactly how tax and duties are calculated, as well as any exemptions that apply. See https://en.wikipedia.org/wiki/De_minimis for more information.", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/deminimis_simple" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/deminimis_per_item" | |
| } | |
| ] | |
| }, | |
| "document": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/catalog_item_document" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/harmonization_document" | |
| } | |
| ] | |
| }, | |
| "event": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/attribute_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/attribute_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/attribute_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/attribute_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/catalog_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/catalog_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/subcatalog_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/subcatalog_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/catalog_item_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/catalog_item_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/catalog_item_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/catalog_item_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/subcatalog_item_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/subcatalog_item_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/b2b_invoice_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/b2b_invoice_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/consumer_invoice_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/consumer_invoice_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/credit_memo_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/credit_memo_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/crossdock_shipment_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/rate_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/rate_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/available_promotions_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/available_promotions_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/available_promotions_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/available_promotions_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/allocation_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/allocation_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/currency_format_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/currency_format_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_price_book_mapping_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_price_book_mapping_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_logistics_settings_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_logistics_settings_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/item_margin_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/item_margin_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/item_sales_margin_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/item_sales_margin_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/label_format_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/label_format_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_identifier_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_identifier_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_identifier_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_identifier_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/pricing_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/pricing_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/fraud_status_changed" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/center_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/center_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/delivery_option_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/delivery_option_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/shipping_configuration_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/shipping_configuration_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/tier_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/tier_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/shipping_lane_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/shipping_lane_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/shipping_configuration_item_availability_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/shipping_configuration_item_availability_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/hs6_code_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/hs6_code_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/hs10_code_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/hs10_code_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/item_origin_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/item_origin_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/harmonized_item_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/harmonized_item_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/harmonized_landed_cost_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/fully_harmonized_item_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/rule_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/rule_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/serial_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/serial_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/snapshot_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/snapshot_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/label_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/notification_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/notification_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/manifested_label_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/manifested_label_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/local_item_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/local_item_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/checkout_optin_responses_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/checkout_optin_responses_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/browse_optin_responses_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/browse_optin_responses_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_placed" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/ready_to_fulfill" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/membership_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/membership_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/organization_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/organization_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/organization_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/organization_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/organization_short_id_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/organization_short_id_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/authorization_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/authorization_status_changed" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/card_authorization_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/card_authorization_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/online_authorization_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/online_authorization_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/capture_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/capture_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/card_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/card_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/payment_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/payment_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/refund_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/refund_deleted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/refund_capture_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/reversal_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/reversal_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/capture_identifier_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/capture_identifier_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/refund_identifier_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/refund_identifier_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/virtual_card_capture_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/virtual_card_capture_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/virtual_card_refund_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/virtual_card_refund_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/price_book_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/price_book_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/price_book_item_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/price_book_item_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/organization_rates_published" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/organization_countries_published" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/return_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/return_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/shopify_localization_setting_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/shopify_localization_setting_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/targeting_item_upserted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/targeting_item_upserted_v2" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/targeting_item_deleted" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/targeting_item_deleted_v3" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/tracking_label_event_upserted" | |
| } | |
| ] | |
| }, | |
| "expandable_card": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/card" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/card_reference" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/card_summary" | |
| } | |
| ] | |
| }, | |
| "expandable_center": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/center" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/center_reference" | |
| } | |
| ] | |
| }, | |
| "expandable_experience": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/experience" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_reference" | |
| } | |
| ] | |
| }, | |
| "expandable_order": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/order" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_reference" | |
| } | |
| ] | |
| }, | |
| "expandable_organization": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/organization_reference" | |
| } | |
| ] | |
| }, | |
| "expandable_subcatalog": { | |
| "description": "A subcatalog can be represented with just it's ID, or the entire model", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/subcatalog" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/subcatalog_reference" | |
| } | |
| ] | |
| }, | |
| "expandable_user": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/user" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/user_reference" | |
| } | |
| ] | |
| }, | |
| "export_delivery": { | |
| "description": "Export deliveries represent actions to take once a requested export has completed. A common pattern would be to request delivery of the export via email - you will then receive an email notification once the requested export is ready", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/export_delivery_email" | |
| } | |
| ] | |
| }, | |
| "export_type": { | |
| "description": "Defines the specific export data that defines which records are exported and into which format", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/account_transactions_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/account_orders_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/analytics_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/catalog_item_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/harmonization_overview_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/harmonization_hs6_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/harmonization_hs10_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/unharmonized_item_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/solidus_product_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/solidus_variant_export_type" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/localized_item_prices_export_type" | |
| } | |
| ] | |
| }, | |
| "feed": { | |
| "description": "Describes types of feeds that may be produced by Flow.", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/catalog_feed" | |
| } | |
| ] | |
| }, | |
| "flow_role": { | |
| "description": "All roles available to attach to a user.", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/flow_user_role" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/flow_addon_role" | |
| } | |
| ] | |
| }, | |
| "gateway_authentication_data": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/stripe_authentication_data" | |
| } | |
| ] | |
| }, | |
| "gateway_authentication_data_form": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/stripe_authentication_data_form" | |
| } | |
| ] | |
| }, | |
| "hint_form": { | |
| "description": "Describes types of forms that can be used to assign an HS code based on product data.", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/phrase_hint_form" | |
| } | |
| ] | |
| }, | |
| "input_specification_limitation": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/input_specification_limitation_max" | |
| } | |
| ] | |
| }, | |
| "inventory_strategy": { | |
| "description": "Types of rules used to apply on inventory to calculate available quantity", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/inventory_backorder" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/inventory_stock" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/inventory_unlimited" | |
| } | |
| ] | |
| }, | |
| "localized_price": { | |
| "description": "The localized prices for an item are returned as a list - the key of each element is defined here", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/localized_item_price" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/localized_item_vat" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/localized_item_duty" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/localized_total" | |
| } | |
| ] | |
| }, | |
| "online_authorization_details": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/paypal_authorization_details" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/redirect_authorization_details" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/inline_authorization_details" | |
| } | |
| ] | |
| }, | |
| "order_number_generator": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/order_number_generator_uuid" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_number_generator_hexadecimal" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/order_number_generator_prefix_suffix" | |
| } | |
| ] | |
| }, | |
| "order_promotion": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/free_shipping_order_promotion" | |
| } | |
| ] | |
| }, | |
| "order_promotion_form": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/free_shipping_order_promotion_form" | |
| } | |
| ] | |
| }, | |
| "partner_center_fee": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/commercial_invoice_fee" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/inbound_carton_fee" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/outbound_carton_fee" | |
| } | |
| ] | |
| }, | |
| "payment": { | |
| "description": "Represents data for a specific online payment method", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/payment_paypal" | |
| } | |
| ] | |
| }, | |
| "payment_form": { | |
| "description": "Represents the data needed to initiate an online payment", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/merchant_of_record_payment_form" | |
| } | |
| ] | |
| }, | |
| "payment_method_tag": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/organization_payment_method_tag" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/experience_payment_method_tag" | |
| } | |
| ] | |
| }, | |
| "promotion": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/free_shipping" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/discount" | |
| } | |
| ] | |
| }, | |
| "query_builder_form": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/query_builder_filter_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/query_builder_query_form" | |
| } | |
| ] | |
| }, | |
| "query_filter": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/query_filter_structured" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/query_filter_unstructured" | |
| } | |
| ] | |
| }, | |
| "query_filter_form": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/query_filter_structured_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/query_filter_unstructured_form" | |
| } | |
| ] | |
| }, | |
| "reservation_error": { | |
| "description": "Types of failed inventory reservation reasons", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/no_inventory_reservation_error" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/external_api_timeout_reservation_error" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/generic_reservation_error" | |
| } | |
| ] | |
| }, | |
| "session": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/organization_session" | |
| } | |
| ] | |
| }, | |
| "session_authorization": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/organization_session_authorization" | |
| } | |
| ] | |
| }, | |
| "shipping_label_form": { | |
| "description": "Different models for forms to create shipping labels", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/detailed_shipping_label_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/summary_shipping_label_form" | |
| } | |
| ] | |
| }, | |
| "shipping_notification_form": { | |
| "description": "Form for information about a client-facilitated shipment where the shipping label and fulfillment was not handled by Flow. For merchant-of-record and tracking purposes, clients doing their own shipping will need to notify Flow of shipped packages.", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/detailed_shipping_notification_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/single_package_shipping_notification_form" | |
| } | |
| ] | |
| }, | |
| "shopify_cart_add_form": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/shopify_cart_add_single_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/shopify_cart_add_multiple_form" | |
| } | |
| ] | |
| }, | |
| "shopify_event_bucket": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/shopify_item_event_bucket" | |
| } | |
| ] | |
| }, | |
| "tier_rule_outcome": { | |
| "description": "Possible outcome types from a tier rule", | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/amount_margin" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/at_cost" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/flat_rate" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/percent_margin" | |
| } | |
| ] | |
| }, | |
| "tier_rule_outcome_form": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/amount_margin_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/flat_rate_form" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/at_cost" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/percent_margin" | |
| } | |
| ] | |
| }, | |
| "token": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/organization_token" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/partner_token" | |
| } | |
| ] | |
| }, | |
| "token_reference": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/organization_token_reference" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/partner_token_reference" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "info": { | |
| "contact": { | |
| "email": "[email protected]" | |
| }, | |
| "description": "The Flow Commerce REST API provides full access to the global ecommerce platform.", | |
| "license": { | |
| "name": "MIT", | |
| "url": "http://opensource.org/licenses/MIT" | |
| }, | |
| "termsOfService": "", | |
| "title": "API", | |
| "version": "0.7.25" | |
| }, | |
| "openapi": "3.0.2", | |
| "paths": { | |
| "/:organization/orders/allocations/:number": { | |
| "get": { | |
| "description": "Order-level price details allocated using a strategy among individual order item units.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["allocation"] | |
| } | |
| }, | |
| "/:organization/attributes": { | |
| "get": { | |
| "description": "Search attributes. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["attribute"] | |
| }, | |
| "post": { | |
| "description": "Add attribute", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/attribute_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["attribute"] | |
| } | |
| }, | |
| "/:organization/attributes/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["attribute"] | |
| } | |
| }, | |
| "/:organization/attributes/:key": { | |
| "get": { | |
| "description": "Returns information about a specific attribute.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["attribute"] | |
| }, | |
| "put": { | |
| "description": "Create or update an attribute with the specified key.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/attribute_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["attribute"] | |
| }, | |
| "delete": { | |
| "description": "Delete an attribute with the specified key.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["attribute"] | |
| } | |
| }, | |
| "/:organization/catalog": { | |
| "get": { | |
| "description": "Returns information about a specific catalog.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["catalog"] | |
| } | |
| }, | |
| "/:organization/catalog/restrictions": { | |
| "get": { | |
| "description": "Search global restrictions. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["catalog"] | |
| } | |
| }, | |
| "/:organization/catalog/restrictions/:number": { | |
| "get": { | |
| "description": "Returns a specific globally restricted item.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["catalog"] | |
| }, | |
| "put": { | |
| "description": "Upsert a global restriction", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["catalog"] | |
| }, | |
| "delete": { | |
| "description": "Delete the global restriction for this catalog item number", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["catalog"] | |
| } | |
| }, | |
| "/:organization/catalog/statistics": { | |
| "get": { | |
| "description": "Get statistics for this organization's catalog.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["catalog"] | |
| } | |
| }, | |
| "/:organization/checkout/attributes": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["checkout_attribute"] | |
| }, | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/checkout_attribute_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["checkout_attribute"] | |
| } | |
| }, | |
| "/:organization/checkout/attributes/:id": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["checkout_attribute"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/checkout_attribute_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["checkout_attribute"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["checkout_attribute"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/item/content/checkout": { | |
| "get": { | |
| "description": "Returns a localized view of 1 or more items in the context of checkout, returning data specifically related to rendering a view of an item in a cart or checkout page.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["checkout_item_content"] | |
| } | |
| }, | |
| "/:organization/credit/payments": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "order_number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["credit_payment"] | |
| }, | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/credit_payment_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["credit_payment"] | |
| } | |
| }, | |
| "/:organization/credit/payments/versions": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["credit_payment"] | |
| } | |
| }, | |
| "/:organization/credit/payments/:key": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["credit_payment"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/credit_payment_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["credit_payment"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["credit_payment"] | |
| } | |
| }, | |
| "/:organization/experiences": { | |
| "get": { | |
| "description": "Search experiences. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "q" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "name" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "region" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/components/schemas/experience_status" | |
| }, | |
| "name": "status" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "shipping_configuration_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "post": { | |
| "description": "Add experience", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/experience_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/conversions/:base/:amount": { | |
| "get": { | |
| "description": "Formats the requested amount using the formatting settings for the experience.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "The currency of the provided amount, which will be converted to the experience currency, unless a value is specified for the `currency` parameter.", | |
| "name": "base" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "The amount in the base currency to be converted.", | |
| "name": "amount" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, the provided base amount will be converted to and formatted in this currency.", | |
| "name": "currency" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/items": { | |
| "get": { | |
| "description": "Returns localized information about 1 or more items. The items will be localized based on the experience selected by the query parameters in the order of experience, then country, then ip address.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/subcatalog_item_status" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to items based on their status within this subcatalog", | |
| "name": "status" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will select the experience matching this country. ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)", | |
| "name": "language" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/items/:number": { | |
| "get": { | |
| "description": "Returns information about this item localized based on the query parameters", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages", | |
| "name": "language" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/query/builders": { | |
| "post": { | |
| "description": "Builds a query to search experiences", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/query_builder_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/currency/formats": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/experience_currency_format_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/logistics/summary": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If not specified, we will use the experience default country. ISO 3166 3 country code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If not specified, we will use the experience default currency. ISO 3166 3 currency code as defined in https://api.flow.io/reference/currencies", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Specific item number for which to generate a summary", | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/margins": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/item_margin_post_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/margins/versions": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/margins/:key": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/item_margin_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/payment-method-types": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/payment/method/rules": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/payment_method_type" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "payment_method_type" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "tags" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will ensure that any available installment programs are adjusted to be <= this amount. If specified, must also specify currency", | |
| "name": "amount" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Required if amount is specified", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "put": { | |
| "description": "Change the ordering or payment tags for an experience. Every post must include one entry for each payment method offered by Flow.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/experience_payment_method_rule_form" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/price/books": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "price_book_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/experience_price_book_mapping_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/price/books/:key": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:key": { | |
| "get": { | |
| "description": "Returns information about a specific experience.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "put": { | |
| "description": "Update experience with the specified key, creating if it does not exist.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/experience_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "delete": { | |
| "description": "Delete the experience with this key", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:key/items/:number/price": { | |
| "get": { | |
| "description": "Returns detailed information on the pricing of this item within this experience", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:key/pricing": { | |
| "get": { | |
| "description": "Get the pricing settings for this experience", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| }, | |
| "put": { | |
| "description": "Update the pricing settings for this experience", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/pricing" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:key/promotions/available": { | |
| "get": { | |
| "description": "Get available promotions for the experience", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experiences/:key/status": { | |
| "put": { | |
| "description": "Updates the status of a given experience.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/experience_status_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience"] | |
| } | |
| }, | |
| "/:organization/experience/defaults": { | |
| "get": { | |
| "description": "Returns recommended default settings when creating a new experience", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "region_id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience_defaults"] | |
| } | |
| }, | |
| "/:organization/experiences/:experience_key/settings/logistics": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience_logistics_settings"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "experience_key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/experience_logistics_settings_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["experience_logistics_settings"] | |
| } | |
| }, | |
| "/:organization/catalog/items": { | |
| "get": { | |
| "description": "Search items. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Find items with this number. Case insensitive. Exact match", | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["item"] | |
| }, | |
| "post": { | |
| "description": "Add catalog item(s)", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/item_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["item"] | |
| } | |
| }, | |
| "/:organization/catalog/items/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to items with any one of these numbers.", | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["item"] | |
| } | |
| }, | |
| "/:organization/catalog/items/:number": { | |
| "get": { | |
| "description": "Returns information about a specific item.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["item"] | |
| }, | |
| "put": { | |
| "description": "Update item with the specified number, creating if it does not exist.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/item_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["item"] | |
| }, | |
| "delete": { | |
| "description": "Delete the item with this number", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["item"] | |
| } | |
| }, | |
| "/:organization/catalog/items/:number/attributes": { | |
| "patch": { | |
| "description": "Update item with the specified attributes.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/item_attributes_patch_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["item"] | |
| } | |
| }, | |
| "/:organization/catalog/items/:number/price": { | |
| "put": { | |
| "description": "Update item with the specified number, creating if it does not exist.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/item_price_update_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["item"] | |
| } | |
| }, | |
| "/:organization/orders": { | |
| "get": { | |
| "description": "Search orders. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/components/schemas/order_status" | |
| }, | |
| "name": "status" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "description": "If specified, we filter to all records that have a 'submitted_at' >= 'submitted_at_on_or_after'", | |
| "name": "submitted_at_on_or_after" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin", | |
| "name": "romanize" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| }, | |
| "post": { | |
| "description": "Create an order, using the localized information from the experience selected by the query parameters. Note the order must be submitted before its expiration", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will select the experience matching this country. ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)", | |
| "name": "language" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin", | |
| "name": "romanize" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/identifier/:identifier": { | |
| "get": { | |
| "description": "Returns information about a specific order using an identifier number", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each order, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "description": "If specified, we filter to all records that have a 'journal_timestamp' >= 'journal_timestamp_on_or_after'", | |
| "name": "journal_timestamp_on_or_after" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number": { | |
| "get": { | |
| "description": "Returns information about a specific order.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin", | |
| "name": "romanize" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| }, | |
| "put": { | |
| "description": "Upserts an order. using the localized information from the experience selected by the query parameters. Note the order must be submitted before its expiration", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will select the experience matching this country. ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)", | |
| "name": "language" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin", | |
| "name": "romanize" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| }, | |
| "delete": { | |
| "description": "Delete an order. Note that production orders that have already been submitted cannot be deleted (you will see a 422 response in these cases).", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/allocations": { | |
| "get": { | |
| "description": "Order allocations provide a granular view of an order that is targeted for accounting / financial views of an order", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/authorizations": { | |
| "post": { | |
| "description": "Creates an authorization, automatically associating to this order.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/authorization_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/destination": { | |
| "put": { | |
| "description": "Updates an order's destination address", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_destination_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/installment/plan/authorizations": { | |
| "post": { | |
| "description": "Creates an installment plan for this order, automatically associating to this order.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/installment_plan_payment_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/inventory/reservations": { | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/promotions/:key/free_shipping": { | |
| "put": { | |
| "description": "Creates a free shipping promotion for this order, automatically applying it to the order if the order meets the defined promotion trigger.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/free_shipping_order_promotion_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/submissions": { | |
| "put": { | |
| "description": "Submits an order. You will get a validation error if the order has already expired (and a new quote could not be automatically recreated for a lower or same price). This method is idempotent - submitting an order a second time has no effect.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "undefinedApibuilder defined this parameter location as \"Form\" which is incompatible with the OpenAPI spec.", | |
| "name": "expand" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/tax/registration": { | |
| "put": { | |
| "description": "Validates a tax registration number, proxying to underlying services and recording the result on the order.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/tax_registration_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/tax/registration/:key": { | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/status/fraud": { | |
| "get": { | |
| "description": "Returns the current fraud status for this order", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/orders/:number/labels": { | |
| "post": { | |
| "description": "Generate a shipping label given only an order number for the organization. This will assume all items in the order will be shipped and that there are no updates to the contact or destination address information.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order"] | |
| } | |
| }, | |
| "/:organization/order/builders": { | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will select the experience matching this country. ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)", | |
| "name": "language" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_builder"] | |
| } | |
| }, | |
| "/:organization/order/builders/carts/:number": { | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will select the experience matching this country. ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)", | |
| "name": "language" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_builder"] | |
| } | |
| }, | |
| "/:organization/order/builders/:number": { | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will select the experience matching this country. ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)", | |
| "name": "language" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_builder"] | |
| } | |
| }, | |
| "/:organization/order/builders/:number/attributes": { | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_builder_attributes_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_builder"] | |
| } | |
| }, | |
| "/:organization/order/builders/:number/country": { | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_builder_destination_country_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_builder"] | |
| } | |
| }, | |
| "/:organization/order/builders/:number/destination": { | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_builder_destination_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_builder"] | |
| } | |
| }, | |
| "/:organization/order/builders/:number/duty": { | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_builder_delivered_duty_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_builder"] | |
| } | |
| }, | |
| "/:organization/order-estimates": { | |
| "post": { | |
| "description": "Create an order estimate, using the localized information from the experience selected by the query parameters. This is similar to the POST orders endpoint, except this just returns an estimate and cannot be submitted.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will select the experience matching this country. ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)", | |
| "name": "language" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin", | |
| "name": "romanize" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_estimate_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_estimate"] | |
| } | |
| }, | |
| "/:organization/order-estimates/:number": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin", | |
| "name": "romanize" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_estimate"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will render the items in the context of the experience with this key.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will select the experience matching this country. ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)", | |
| "name": "language" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin", | |
| "name": "romanize" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_estimate_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_estimate"] | |
| } | |
| }, | |
| "/:organization/order-identifiers": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "identifier" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "order_number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_identifier"] | |
| }, | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_identifier_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_identifier"] | |
| } | |
| }, | |
| "/:organization/order-identifiers/versions": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_identifier"] | |
| } | |
| }, | |
| "/:organization/order-identifiers/:identifier": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_identifier"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_identifier_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_identifier"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_identifier"] | |
| } | |
| }, | |
| "/:organization/order/number/generators": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_number_generator"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/order_number_generator" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_number_generator"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_number_generator"] | |
| } | |
| }, | |
| "/:organization/order/promotions/:key": { | |
| "delete": { | |
| "description": "Deletes the order promotion with the specified key", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["order_promotion"] | |
| } | |
| }, | |
| "/:organization/countries": { | |
| "get": { | |
| "description": "The countries resources provides a unique list of all of the countries for which an experience exists. We generate this list of countries by iterating through all of the experience regions, and collecting all of the countries.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we lookup the country associated with this IP address, and if found and there is an experience that is targeted to this country, we guarantee that this country is in the returned list of countries", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will guarantee that this country is included in the response. We recommend including the current country when querying for the list of countries to disable, thereby ensuring the current user's selection will display (even if they are localized using the world experience). Value is a ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/experience_status" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "If specified, countries will be filtered from experiences with this status. If not provided, defaults to active.", | |
| "name": "status" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| } | |
| }, | |
| "/:organization/countries/destinations": { | |
| "get": { | |
| "description": "List of all destination countries available for this organization, including countries within a world experience.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| } | |
| }, | |
| "/organizations": { | |
| "get": { | |
| "description": "Search organizations. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Find organizations with this name. Case insensitive. Exact match.", | |
| "name": "name" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/components/schemas/environment" | |
| }, | |
| "description": "Find organizations with this environment", | |
| "name": "environment" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Find organizations that belong to this specified parent organization id. Case insensitive. Exact match.", | |
| "name": "parent" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| }, | |
| "post": { | |
| "description": "Create a new organization.", | |
| "parameters": [], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/organization_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| } | |
| }, | |
| "/organizations/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to organizations with any one of these ids.", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| } | |
| }, | |
| "/organizations/:organization_id": { | |
| "get": { | |
| "description": "Returns information about a specific organization.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "organization_id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| }, | |
| "put": { | |
| "description": "Update or create an organization with the specified id.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "organization_id" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/organization_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| }, | |
| "delete": { | |
| "description": "Delete the organization with this id", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "organization_id" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| } | |
| }, | |
| "/organizations/:organization_id/settings/currencies": { | |
| "get": { | |
| "description": "Returns currencies for a specific organization.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "organization_id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| } | |
| }, | |
| "/organizations/:organization_id/settings/regions": { | |
| "get": { | |
| "description": "Returns the region settings associated to a specific organization.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "organization_id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| } | |
| }, | |
| "/organizations/:organization_id/settings/regions/countries/available": { | |
| "get": { | |
| "description": "Returns the list of enabled countries based on the region settings for a specific organization", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "organization_id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| } | |
| }, | |
| "/organizations/:organization_id/settings/regions/:region": { | |
| "put": { | |
| "description": "Updates or creates a region setting for a specific organization", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "organization_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "region" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/region_setting_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| }, | |
| "delete": { | |
| "description": "Removes the setting for this region for a specific organization", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "organization_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "region" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization"] | |
| } | |
| }, | |
| "/:organization/payment-method-rules": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filters available payment methods to those available for the experience associated with the provided country.", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will ensure that any available installment programs are adjusted to be <= this amount. If specified, must also specify currency", | |
| "name": "amount" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filters available payment methods to those that support the provided currency.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If provided, the payment methods available for the corresponding experience will be returned.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If provided, will be used to help pick the experience if the country or experience key are not provided.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["payment_method_rule"] | |
| } | |
| }, | |
| "/:organization/payment/method/rules": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filters available payment methods to those available for the experience associated with the provided country.", | |
| "name": "country" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If specified, we will ensure that any available installment programs are adjusted to be <= this amount. If specified, must also specify currency", | |
| "name": "amount" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filters available payment methods to those that support the provided currency.", | |
| "name": "currency" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If provided, the payment methods available for the corresponding experience will be returned.", | |
| "name": "experience" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "If provided, will be used to help pick the experience if the country or experience key are not provided.", | |
| "name": "ip" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["payment_method_rule"] | |
| } | |
| }, | |
| "/:organization/price/books": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book"] | |
| }, | |
| "post": { | |
| "description": "Create a price book.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/price_book_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book"] | |
| } | |
| }, | |
| "/:organization/price/books/:key": { | |
| "get": { | |
| "description": "Returns information about a specific price book.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book"] | |
| }, | |
| "put": { | |
| "description": "Create or update a price book.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/price_book_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book"] | |
| }, | |
| "delete": { | |
| "description": "Deletes the specified price book", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book"] | |
| } | |
| }, | |
| "/:organization/price/books/:price_book_key/items": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "price_book_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book_item"] | |
| }, | |
| "post": { | |
| "description": "Create a price book item.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "price_book_key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/price_book_item_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book_item"] | |
| } | |
| }, | |
| "/:organization/price/books/:price_book_key/items/:key": { | |
| "get": { | |
| "description": "Returns information about a specific price book item.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "price_book_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book_item"] | |
| }, | |
| "put": { | |
| "description": "Create or update a price book item.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "price_book_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/price_book_item_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book_item"] | |
| }, | |
| "delete": { | |
| "description": "Deletes the specified price book item", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "price_book_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["price_book_item"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs": { | |
| "get": { | |
| "description": "Search subcatalogs. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "post": { | |
| "description": "Add subcatalog", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/subcatalog_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:id": { | |
| "get": { | |
| "description": "Returns information about a specific subcatalog.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "put": { | |
| "description": "Update subcatalog with the specified id, creating if it does not exist.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/subcatalog_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "delete": { | |
| "description": "Delete the subcatalog with this id", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:id/settings": { | |
| "get": { | |
| "description": "Returns information about a specific subcatalog's settings.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "put": { | |
| "description": "Update subcatalog settings for the specified subcatalog.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/subcatalog_settings_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/exclusions": { | |
| "get": { | |
| "description": "Search exclusions. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/exclusions/:number": { | |
| "get": { | |
| "description": "Returns information about a specific exclusion by catalog item number.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "put": { | |
| "description": "Add exclusion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "delete": { | |
| "description": "Delete an exclusion with this catalog item number", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/inclusions": { | |
| "get": { | |
| "description": "Search inclusions. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/inclusions/:number": { | |
| "get": { | |
| "description": "Returns information about a specific inclusion by catalog item number.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "put": { | |
| "description": "Add inclusion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "delete": { | |
| "description": "Delete an inclusion with this catalog item number", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/queries": { | |
| "get": { | |
| "description": "Search queries. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "type" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "post": { | |
| "description": "Add query", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/subcatalog_query_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/queries/:id": { | |
| "get": { | |
| "description": "Returns information about a specific query.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| }, | |
| "delete": { | |
| "description": "Delete a query with this id", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/statistics": { | |
| "get": { | |
| "description": "Get statistics for the specified subcatalog", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/items": { | |
| "get": { | |
| "description": "Search subcatalog items. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/subcatalog_item_status" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to items with a status as defined in https://docs.flow.io/types.html#type-subcatalog-item-status", | |
| "name": "status" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog_item"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/items/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to items with any one of these numbers.", | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog_item"] | |
| } | |
| }, | |
| "/:organization/catalog/subcatalogs/:subcatalog_id/items/:number": { | |
| "get": { | |
| "description": "Returns information about specific subcatalog items.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "subcatalog_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog_item"] | |
| } | |
| }, | |
| "/:organization/query/validations": { | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["subcatalog_query"] | |
| } | |
| }, | |
| "/:organization/catalog/targetings": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["targeting"] | |
| }, | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/targeting_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["targeting"] | |
| } | |
| }, | |
| "/:organization/catalog/targetings/:key": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["targeting"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/targeting_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["targeting"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["targeting"] | |
| } | |
| }, | |
| "/:organization/catalog/targeting-items": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Key of the targeting", | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Number of the item", | |
| "name": "item_number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["targeting_item"] | |
| } | |
| }, | |
| "/:organization/currency/settings": { | |
| "get": { | |
| "description": "Search organization currency settings. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by the (case-insensitive) base currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies", | |
| "name": "base" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by the (case-insensitive) target currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies", | |
| "name": "target" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization_currency_setting"] | |
| }, | |
| "post": { | |
| "description": "Create organization currency settings.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/organization_currency_setting_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization_currency_setting"] | |
| } | |
| }, | |
| "/:organization/currency/settings/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization_currency_setting"] | |
| } | |
| }, | |
| "/:organization/currency/settings/:id": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization_currency_setting"] | |
| }, | |
| "put": { | |
| "description": "Update an existing organization currency setting by id.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/organization_currency_setting_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization_currency_setting"] | |
| }, | |
| "delete": { | |
| "description": "Delete the organization currency setting with this id.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["organization_currency_setting"] | |
| } | |
| }, | |
| "/:organization/currency/rates": { | |
| "get": { | |
| "description": "Search organization currency conversion rates. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more (case-insensitive) base currency ISO 4217 3-character codes, as defined in https://api.flow.io/reference/currencies", | |
| "name": "base" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by the (case-insensitive) target currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies", | |
| "name": "target" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/components/schemas/rate_type" | |
| }, | |
| "description": "Filter by rate type", | |
| "name": "type" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["rate"] | |
| } | |
| }, | |
| "/:organization/currency/rates/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by the (case-insensitive) base currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies", | |
| "name": "base" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by the (case-insensitive) target currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies", | |
| "name": "target" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/components/schemas/rate_type" | |
| }, | |
| "description": "Filter by rate type", | |
| "name": "type" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["rate"] | |
| } | |
| }, | |
| "/:organization/harmonization/settings": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonization_settings"] | |
| }, | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/harmonization_settings_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonization_settings"] | |
| } | |
| }, | |
| "/:organization/harmonization/categories": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "parent_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_category"] | |
| } | |
| }, | |
| "/:organization/harmonization/items": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item"] | |
| }, | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/harmonized_item_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item"] | |
| } | |
| }, | |
| "/:organization/harmonization/items/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to items with any one of these ids.", | |
| "name": "item_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item"] | |
| } | |
| }, | |
| "/:organization/harmonization/items/:number": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item"] | |
| }, | |
| "put": { | |
| "description": "Create or update an item to harmonize", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/harmonized_item_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "number" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item"] | |
| } | |
| }, | |
| "/:organization/harmonization/item-duties": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "The ISO 3166 3 character country code of the country of origin", | |
| "name": "origin" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "The ISO 3166 3 character country code of the destination country", | |
| "name": "destination" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item_duty"] | |
| }, | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/harmonized_item_duty_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item_duty"] | |
| } | |
| }, | |
| "/:organization/harmonization/item-duties/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to item duties with any one of these ids.", | |
| "name": "harmonized_item_duty_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item_duty"] | |
| } | |
| }, | |
| "/:organization/harmonization/item-duties/:id": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item_duty"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_item_duty"] | |
| } | |
| }, | |
| "/:organization/harmonization/landed-costs": { | |
| "post": { | |
| "description": "Single operation that provides harmonization landed costs (i.e. duties and taxes) for 1 or more items. This method is designed to enable a single call from applications that need it (like checkout) to get all data for a collection of items", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/harmonized_landed_cost_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["harmonized_landed_cost"] | |
| } | |
| }, | |
| "/:organization/harmonization/hs10": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "item_number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "The ISO 3166 3 character country code of the destination country", | |
| "name": "origin" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "The ISO 3166 3 character country code of the destination country", | |
| "name": "destination" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter to records matching this HS-10 code", | |
| "name": "code" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["hs10"] | |
| } | |
| }, | |
| "/:organization/harmonization/hs10/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to HS-10s with any one of these ids.", | |
| "name": "hs10_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["hs10"] | |
| } | |
| }, | |
| "/:organization/harmonization/hs6": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "item_number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter to records matching this HS-6 code", | |
| "name": "code" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["hs6"] | |
| } | |
| }, | |
| "/:organization/harmonization/hs6/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to HS-6s with any one of these ids.", | |
| "name": "hs6_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["hs6"] | |
| } | |
| }, | |
| "/harmonization/codes": { | |
| "get": { | |
| "description": "Search harmonization codes. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Find these specific harmonization codes. Case insensitive.", | |
| "name": "code" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Find records with this parent harmonization code. Case insensitive.", | |
| "name": "parent" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| }, | |
| "description": "Find records with or without a parent code.", | |
| "name": "has_parent" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "unit", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["hs_code"] | |
| } | |
| }, | |
| "/harmonization/codes/:code": { | |
| "get": { | |
| "description": "Returns information about a specific harmonization code.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "code" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "unit", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["hs_code"] | |
| } | |
| }, | |
| "/harmonization/tariff-codes/:destination": { | |
| "get": { | |
| "description": "Search harmonization codes. Always paginated.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "destination" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["tariff_code"] | |
| } | |
| }, | |
| "/harmonization/tariff-codes/:destination/:code": { | |
| "get": { | |
| "description": "Returns information about a specific tariff code.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "destination" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "code" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["tariff_code"] | |
| } | |
| }, | |
| "/:organization/tax/registrations": { | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/tax_registration_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["tax_registration"] | |
| } | |
| }, | |
| "/:organization/tax/registrations/:key": { | |
| "put": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/tax_registration_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["tax_registration"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["tax_registration"] | |
| } | |
| }, | |
| "/:organization/authorizations": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "order_number" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["authorization"] | |
| }, | |
| "post": { | |
| "description": "Create a new authorization.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/authorization_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["authorization"] | |
| } | |
| }, | |
| "/:organization/authorizations/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to authorizations with any one of these ids.", | |
| "name": "authorization_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["authorization"] | |
| } | |
| }, | |
| "/:organization/authorizations/:key": { | |
| "get": { | |
| "description": "Returns information about a specific authorization.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["authorization"] | |
| }, | |
| "put": { | |
| "description": "Attempts to create an authorization identified by the provided key. Multiple requests using the same key are idempotent.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "expand" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/authorization_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["authorization"] | |
| }, | |
| "delete": { | |
| "description": "Deprecated. This end point no longer deletes an authorization and is implemented by creating a reversal for the remaining balance on the auth.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["authorization"] | |
| } | |
| }, | |
| "/:organization/captures": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "authorization_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "authorization_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["capture"] | |
| }, | |
| "post": { | |
| "description": "Create a new capture.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/capture_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["capture"] | |
| } | |
| }, | |
| "/:organization/captures/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to captures with any one of these ids.", | |
| "name": "capture_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["capture"] | |
| } | |
| }, | |
| "/:organization/captures/:key": { | |
| "get": { | |
| "description": "Returns information about a specific capture.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["capture"] | |
| } | |
| }, | |
| "/:organization/captures/:key/identifiers": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["capture"] | |
| } | |
| }, | |
| "/:organization/captures/:key/identifiers/:identifier": { | |
| "put": { | |
| "description": "Create a new identifier for this capture", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/identifier_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["capture"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["capture"] | |
| } | |
| }, | |
| "/:organization/cards": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "token" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["card"] | |
| }, | |
| "post": { | |
| "description": "Create a new card. Note that when using JSONP to submit a card, you do not need to authenticate.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/card_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["card"] | |
| } | |
| }, | |
| "/:organization/cards/nonces": { | |
| "post": { | |
| "description": "Creates a card from a one time nonce. Each nonce can be used at most once and you will receive a validation error if the nonce has already been exchanged.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/card_nonce_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["card"] | |
| } | |
| }, | |
| "/:organization/cards/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to cards with any one of these ids.", | |
| "name": "card_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "card_token" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["card"] | |
| } | |
| }, | |
| "/:organization/cards/:token": { | |
| "get": { | |
| "description": "Returns information about a specific card.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "token" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["card"] | |
| }, | |
| "delete": { | |
| "description": "Deletes the specified card", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "token" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["card"] | |
| } | |
| }, | |
| "/:organization/gateways/authentication": { | |
| "post": { | |
| "description": "Specify authentication data for payment processor", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/gateway_authentication_data_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["gateway_authentication_data"] | |
| } | |
| }, | |
| "/:organization/payments": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "payment_method" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["payment"] | |
| }, | |
| "post": { | |
| "description": "Create a new payment. Note that when using JSONP to submit a payment, you do not need to authenticate.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/payment_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["payment"] | |
| } | |
| }, | |
| "/:organization/payments/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to payments with any one of these ids.", | |
| "name": "payment_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["payment"] | |
| } | |
| }, | |
| "/:organization/payments/:id": { | |
| "get": { | |
| "description": "Returns information about a specific payment.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["payment"] | |
| }, | |
| "delete": { | |
| "description": "Deletes the specified payment", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "Payments can be deleted until they are associated with an authorization", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["payment"] | |
| } | |
| }, | |
| "/:organization/encryption/keys": { | |
| "get": { | |
| "description": "Returns your public keys", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["public_key"] | |
| } | |
| }, | |
| "/:organization/encryption/keys/latest": { | |
| "get": { | |
| "description": "Return the latest public key for an organization", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["public_key"] | |
| } | |
| }, | |
| "/:organization/refunds": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "authorization_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "authorization_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "capture_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "capture_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["refund"] | |
| }, | |
| "post": { | |
| "description": "Create a new refund.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/refund_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["refund"] | |
| } | |
| }, | |
| "/:organization/refunds/summary/:order_number": { | |
| "get": { | |
| "description": "Returns a refund order summary for the specified order.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "order_number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["refund"] | |
| } | |
| }, | |
| "/:organization/refunds/versions": { | |
| "get": { | |
| "description": "Provides visibility into recent changes of each object, including deletion", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to refunds with any one of these ids.", | |
| "name": "refund_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["refund"] | |
| } | |
| }, | |
| "/:organization/refunds/:key": { | |
| "get": { | |
| "description": "Returns information about a specific refund.", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["refund"] | |
| } | |
| }, | |
| "/:organization/refunds/:key/identifiers": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["refund"] | |
| } | |
| }, | |
| "/:organization/refunds/:key/identifiers/:identifier": { | |
| "put": { | |
| "description": "Create a new identifier for this refund", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/identifier_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["refund"] | |
| }, | |
| "delete": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "identifier" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Operation succeeded. No content is returned", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["refund"] | |
| } | |
| }, | |
| "/:organization/reversals": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": "key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "authorization_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "authorization_key" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["reversal"] | |
| }, | |
| "post": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/reversal_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "No such authorization", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["reversal"] | |
| } | |
| }, | |
| "/:organization/reversals/versions": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter by one or more IDs of this resource", | |
| "name": "id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "description": "Filter to reversals with any of these IDs", | |
| "name": "reversal_id" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The maximum number of results to return", | |
| "name": "limit" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "description": "The number of results to skip before returning results", | |
| "name": "offset" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "sort" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["reversal"] | |
| } | |
| }, | |
| "/:organization/reversals/:key": { | |
| "get": { | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Resource was not found", | |
| "headers": {} | |
| } | |
| }, | |
| "tags": ["reversal"] | |
| }, | |
| "put": { | |
| "description": "Try inserting or updating a new reversal. Useful for retrying pending reversals", | |
| "parameters": [ | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Refers to your organization's account identifier", | |
| "name": "organization" | |
| }, | |
| { | |
| "deprecated": false, | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": "key" | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/reversal_put_form" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Operation succeeded and the resource was created", | |
| "headers": {} | |
| }, | |
| "401": { | |
| "description": "Authorization failed", | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "io.flow.v0.models.permission_error", | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "No such authorization", | |
| "headers": {} | |
| }, | |
| "422": { | |
| "description": "One |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment