The Flow Commerce REST API provides full access to the global ecommerce platform.
Method and Path | Description | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/address/configurations | Search checkout address configurations. |
||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/address/configurations
Parameters
Responses
|
Method and Path | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/orders/allocations/:number | Order-level price details allocated using a strategy among individual order item units. |
||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/orders/allocations/:number
Parameters
Responses
|
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.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/attributes | Search attributes. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/attributes
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/attributes | Add attribute |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/attributes
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/attributes/versions | Provides visibility into recent changes of each object, including deletion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/attributes/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/attributes/:key | Returns information about a specific attribute. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/attributes/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/attributes/:key | Create or update an attribute with the specified key. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/attributes/:key
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/attributes/:key | Delete an attribute with the specified key. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/attributes/:key
Parameters
Responses
|
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/catalog | Returns information about a specific catalog. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/restrictions | Search global restrictions. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/restrictions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/restrictions/:number | Returns a specific globally restricted item. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/restrictions/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/catalog/restrictions/:number | Upsert a global restriction |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/catalog/restrictions/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/catalog/restrictions/:number | Delete the global restriction for this catalog item number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/catalog/restrictions/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/statistics | Get statistics for this organization’s catalog. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/statistics
Parameters
Responses
|
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.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/checkout/attributes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/checkout/attributes
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/checkout/attributes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/checkout/attributes
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/checkout/attributes/:id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/checkout/attributes/:id
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/checkout/attributes/:id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/checkout/attributes/:id
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/checkout/attributes/:id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/checkout/attributes/:id
Parameters
Responses
|
A Checkout Item Content provides information about an item to support rendering of that item in the context of checkout
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/experiences/:experience_key/item/content/checkout | 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/item/content/checkout
Parameters
Responses
|
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.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/credit/payments | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/credit/payments
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/credit/payments | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/credit/payments
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/credit/payments/versions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/credit/payments/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/credit/payments/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/credit/payments/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/credit/payments/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/credit/payments/:key
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/credit/payments/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/credit/payments/:key
Parameters
Responses
|
Experiences define a local experience for a given geographic region
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/experiences | Search experiences. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/experiences | Add experience |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/experiences
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/conversions/:base/:amount | Formats the requested amount using the formatting settings for the experience. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/conversions/:base/:amount
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/items | 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/items
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/items/:number | Returns information about this item localized based on the query parameters |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/items/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/experiences/query/builders | Builds a query to search experiences |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/experiences/query/builders
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/versions | Provides visibility into recent changes of each object, including deletion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:experience_key/currency/formats | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/currency/formats
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/experiences/:experience_key/currency/formats | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/experiences/:experience_key/currency/formats
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:experience_key/logistics/summary | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/logistics/summary
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:experience_key/margins | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/margins
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/experiences/:experience_key/margins | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/experiences/:experience_key/margins
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:experience_key/margins/versions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/margins/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:experience_key/margins/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/margins/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/experiences/:experience_key/margins/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/experiences/:experience_key/margins/:key
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/experiences/:experience_key/margins/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/experiences/:experience_key/margins/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:experience_key/payment-method-types | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/payment-method-types
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:experience_key/payment/method/rules | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/payment/method/rules
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/experiences/:experience_key/payment/method/rules | Change the ordering or payment tags for an experience. Every post must include one entry for each payment method offered by Flow. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/experiences/:experience_key/payment/method/rules
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:experience_key/price/books | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/price/books
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/experiences/:experience_key/price/books | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/experiences/:experience_key/price/books
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/experiences/:experience_key/price/books | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/experiences/:experience_key/price/books
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:experience_key/price/books/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/price/books/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/experiences/:experience_key/price/books/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/experiences/:experience_key/price/books/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:key | Returns information about a specific experience. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/experiences/:key | Update experience with the specified key, creating if it does not exist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/experiences/:key
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/experiences/:key | Delete the experience with this key |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/experiences/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/experiences/:key/clone | Clones the experience with the specified key, using data from experience_clone_form. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/experiences/:key/clone
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:key/clone/:id | Returns the experience_clone associated with the id. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:key/clone/:id
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:key/items/:number/price | Returns detailed information on the pricing of this item within this experience |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:key/items/:number/price
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:key/pricing | Get the pricing settings for this experience |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:key/pricing
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/experiences/:key/pricing | Update the pricing settings for this experience |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/experiences/:key/pricing
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/experiences/:key/promotions/available | Get available promotions for the experience |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:key/promotions/available
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/experiences/:key/status | Updates the status of a given experience. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/experiences/:key/status
Body
Parameters
Responses
|
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/experiences/:experience_key/settings/checkout | |||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/settings/checkout
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/experiences/:experience_key/settings/checkout | |||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/experiences/:experience_key/settings/checkout
Body
Parameters
Responses
|
Defines a set of defaults for a given organization and region
Method and Path | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/experience/defaults | Returns recommended default settings when creating a new experience |
||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experience/defaults
Parameters
Responses
|
Controls logistics related settings per experience
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/experiences/:experience_key/settings/logistics | |||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/experiences/:experience_key/settings/logistics
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/experiences/:experience_key/settings/logistics | |||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/experiences/:experience_key/settings/logistics
Body
Parameters
Responses
|
The Flow item defines a specific item that can be purchased by a consumer. For many clients, this will map to a Sku.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/catalog/items | Search items. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/items
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/catalog/items | Add catalog item(s) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/catalog/items
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/items/versions | Provides visibility into recent changes of each object, including deletion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/items/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/items/:number | Returns information about a specific item. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/items/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/catalog/items/:number | Update item with the specified number, creating if it does not exist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/catalog/items/:number
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/catalog/items/:number | Delete the item with this number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/catalog/items/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PATCH | /:organization/catalog/items/:number/attributes | Update item with the specified attributes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PATCH https://api.flow.io/:organization/catalog/items/:number/attributes
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/catalog/items/:number/price | Update item with the specified number, creating if it does not exist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/catalog/items/:number/price
Body
Parameters
Responses
|
The item form overlay defines data to merge into an item form.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/catalog/item/overlays | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/item/overlays
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/catalog/item/overlays | Adds an overlay data to merge into a catalog item |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/catalog/item/overlays
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/item/overlays/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/item/overlays/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/catalog/item/overlays/:key | Update item overlay with the specified key, creating if it does not exist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/catalog/item/overlays/:key
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/catalog/item/overlays/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/catalog/item/overlays/:key
Parameters
Responses
|
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.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/orders | Search orders. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/orders
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/orders | Create an order, using the localized information from the experience selected by the query parameters. Note the order must be submitted before its expiration |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/orders
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/orders/identifier/:identifier | Returns information about a specific order using an identifier number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/orders/identifier/:identifier
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/orders/versions | Provides visibility into recent changes of each order, including deletion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/orders/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/orders/:number | Returns information about a specific order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/orders/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/orders/:number | Upserts an order. using the localized information from the experience selected by the query parameters. Note the order must be submitted before its expiration |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/orders/:number
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/orders/:number | Delete an order. Note that production orders that have already been submitted cannot be deleted (you will see a 422 response in these cases). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/orders/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/orders/:number/allocations | Order allocations provide a granular view of an order that is targeted for accounting / financial views of an order |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/orders/:number/allocations
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/orders/:number/authorizations | Creates an authorization, automatically associating to this order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/orders/:number/authorizations
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/orders/:number/destination | Updates an order’s destination address |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/orders/:number/destination
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/orders/:number/installment/plan/authorizations | Creates an installment plan for this order, automatically associating to this order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/orders/:number/installment/plan/authorizations
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/orders/:number/inventory/reservations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/orders/:number/inventory/reservations
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/orders/:number/promotions/:key/free_shipping | Creates a free shipping promotion for this order, automatically applying it to the order if the order meets the defined promotion trigger. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/orders/:number/promotions/:key/free_shipping
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/orders/:number/service/changes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/orders/:number/service/changes
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/orders/:number/submissions | 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/orders/:number/submissions
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/orders/:number/tax/registration | Validates a tax registration number, proxying to underlying services and recording the result on the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/orders/:number/tax/registration
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/orders/:number/tax/registration/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/orders/:number/tax/registration/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/orders/:number/status/fraud | Retrieve the current fraud status for an order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/orders/:number/status/fraud
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/orders/:number/labels/documents/invoice | Generate a commercial invoice for the order without providing a label. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/orders/:number/labels/documents/invoice
Parameters
Responses
|
The Order Builder resource provides an incremental approach to building an order - returning the order details as they exist along with validation errors. The main difference is that this API will never return a 422 - rather it provides a container to view the order in its current state as well as all validation errors
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POST | /:organization/order/builders | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/order/builders
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order/builders/carts/:number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order/builders/carts/:number
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/order/builders/:number | Returns information about a specific order and any errors associated with the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/order/builders/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order/builders/:number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order/builders/:number
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order/builders/:number/attributes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order/builders/:number/attributes
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order/builders/:number/country | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order/builders/:number/country
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order/builders/:number/destination | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order/builders/:number/destination
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order/builders/:number/duty | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order/builders/:number/duty
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order/builders/:number/invoice/address | Update the customer invoice address |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order/builders/:number/invoice/address
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order/builders/:number/tax/registration | Validates a tax registration number, proxying to underlying services and recording the result on the order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order/builders/:number/tax/registration
Body
Parameters
Responses
|
Lightweight estimate for a group of items without any customer-related information. This will contain available estimates on shipping, taxes, and duties.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POST | /:organization/order-estimates | 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/order-estimates
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/order-estimates/:number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/order-estimates/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order-estimates/:number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order-estimates/:number
Body
Parameters
Responses
|
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.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/order-identifiers | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/order-identifiers
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/order-identifiers | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/order-identifiers
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/order-identifiers/versions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/order-identifiers/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/order-identifiers/:identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/order-identifiers/:identifier
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order-identifiers/:identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order-identifiers/:identifier
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/order-identifiers/:identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/order-identifiers/:identifier
Parameters
Responses
|
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/order/number/generators | |||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/order/number/generators
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/order/number/generators | |||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/order/number/generators
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/order/number/generators | |||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/order/number/generators
Parameters
Responses
|
Method and Path | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DELETE | /:organization/order/promotions/:key | Deletes the order promotion with the specified key |
||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/order/promotions/:key
Parameters
Responses
|
The order summary is a view of the order summary object with the order prices flattened to keys.
Method and Path | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/order/summaries/:number | |||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/order/summaries/:number
Parameters
Responses
|
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/countries | 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/countries
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/countries/destinations | List of all destination countries available for this organization, including countries within a world experience. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/countries/destinations
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /organizations | Search organizations. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/organizations
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /organizations | Create a new organization. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/organizations
Body
ParametersNo parametersResponses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /organizations/versions | Provides visibility into recent changes of each object, including deletion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/organizations/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /organizations/:organization_id | Returns information about a specific organization. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/organizations/:organization_id
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /organizations/:organization_id | Update or create an organization with the specified id. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/organizations/:organization_id
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /organizations/:organization_id | Delete the organization with this id |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/organizations/:organization_id
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /organizations/:organization_id/settings/currencies | Returns currencies for a specific organization. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/organizations/:organization_id/settings/currencies
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /organizations/:organization_id/settings/regions | Returns the region settings associated to a specific organization. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/organizations/:organization_id/settings/regions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /organizations/:organization_id/settings/regions/countries/available | Returns the list of enabled countries based on the region settings for a specific organization |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/organizations/:organization_id/settings/regions/countries/available
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /organizations/:organization_id/settings/regions/:region | Updates or creates a region setting for a specific organization |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/organizations/:organization_id/settings/regions/:region
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /organizations/:organization_id/settings/regions/:region | Removes the setting for this region for a specific organization |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/organizations/:organization_id/settings/regions/:region
Parameters
Responses
|
Returns payment methods that are enabled for an organization and available for the provided country and currency.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/payment-method-rules |
deprecated:
Path is deprecated. Use /:organization/payment/method/rules |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/payment-method-rules
deprecated:
Path is deprecated. Use /:organization/payment/method/rules Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/payment/method/rules | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/payment/method/rules
Parameters
Responses
|
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/price/books | |||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/price/books
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/price/books | Create a price book. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/price/books
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/price/books/:key | Returns information about a specific price book. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/price/books/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/price/books/:key | Create or update a price book. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/price/books/:key
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/price/books/:key | Deletes the specified price book |
||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/price/books/:key
Parameters
Responses
|
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/price/books/:price_book_key/items | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/price/books/:price_book_key/items
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/price/books/:price_book_key/items | Create a price book item. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/price/books/:price_book_key/items
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/price/books/:price_book_key/items/:key | Returns information about a specific price book item. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/price/books/:price_book_key/items/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/price/books/:price_book_key/items/:key | Create or update a price book item. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/price/books/:price_book_key/items/:key
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/price/books/:price_book_key/items/:key | Deletes the specified price book item |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/price/books/:price_book_key/items/:key
Parameters
Responses
|
A configuration with custom query to select a subset of master catalog items for a localized experience
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/catalog/subcatalogs | Search subcatalogs. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/catalog/subcatalogs | Add subcatalog |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/catalog/subcatalogs
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/versions | Provides visibility into recent changes of each object, including deletion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:id | Returns information about a specific subcatalog. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:id
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/catalog/subcatalogs/:id | Update subcatalog with the specified id, creating if it does not exist. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/catalog/subcatalogs/:id
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/catalog/subcatalogs/:id | Delete the subcatalog with this id |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/catalog/subcatalogs/:id
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:id/settings | Returns information about a specific subcatalog’s settings. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:id/settings
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/catalog/subcatalogs/:id/settings | Update subcatalog settings for the specified subcatalog. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/catalog/subcatalogs/:id/settings
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:subcatalog_id/exclusions | Search exclusions. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/exclusions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:subcatalog_id/exclusions/:number | Returns information about a specific exclusion by catalog item number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/exclusions/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/catalog/subcatalogs/:subcatalog_id/exclusions/:number | Add exclusion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/exclusions/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/catalog/subcatalogs/:subcatalog_id/exclusions/:number | Delete an exclusion with this catalog item number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/exclusions/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:subcatalog_id/inclusions | Search inclusions. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/inclusions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:subcatalog_id/inclusions/:number | Returns information about a specific inclusion by catalog item number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/inclusions/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/catalog/subcatalogs/:subcatalog_id/inclusions/:number | Add inclusion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/inclusions/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/catalog/subcatalogs/:subcatalog_id/inclusions/:number | Delete an inclusion with this catalog item number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/inclusions/:number
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:subcatalog_id/queries | Search queries. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/queries
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/catalog/subcatalogs/:subcatalog_id/queries | Add query |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/queries
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:subcatalog_id/queries/:id | Returns information about a specific query. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/queries/:id
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/catalog/subcatalogs/:subcatalog_id/queries/:id | Delete a query with this id |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/queries/:id
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:subcatalog_id/statistics | Get statistics for the specified subcatalog |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/statistics
Parameters
Responses
|
Represents information specific to an item in a given subcatalog
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/catalog/subcatalogs/:subcatalog_id/items | Search subcatalog items. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/items
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:subcatalog_id/items/versions | Provides visibility into recent changes of each object, including deletion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/items/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/subcatalogs/:subcatalog_id/items/:number | Returns information about specific subcatalog items. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/subcatalogs/:subcatalog_id/items/:number
Parameters
Responses
|
Represents a typed query to indicate which items to include or exclude in a subcatalog
Method and Path | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POST | /:organization/query/validations | |||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/query/validations
Body
Parameters
Responses
|
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/catalog/targetings | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/targetings
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/catalog/targetings | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/catalog/targetings
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/catalog/targetings/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/targetings/:key
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/catalog/targetings/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/catalog/targetings/:key
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/catalog/targetings/:key | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/catalog/targetings/:key
Parameters
Responses
|
Represents catalog items where a targeting query is applicable
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/catalog/targeting-items | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/catalog/targeting-items
Parameters
Responses
|
Represents organization-specific currency conversion adjustments.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/currency/settings | Search organization currency settings. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/currency/settings
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST | /:organization/currency/settings | Create organization currency settings. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/currency/settings
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/currency/settings/versions | Provides visibility into recent changes of each object, including deletion. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/currency/settings/versions
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/currency/settings/:id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/currency/settings/:id
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/currency/settings/:id | Update an existing organization currency setting by id. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/currency/settings/:id
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE | /:organization/currency/settings/:id | Delete the organization currency setting with this id. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE https://api.flow.io/:organization/currency/settings/:id
Parameters
Responses
|
Represents an organization-specific currency conversion rate at a point in time.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/currency/rates | Search organization currency conversion rates. Always paginated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/currency/rates
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/currency/rates/versions | Provides visibility into recent changes of each object, including deletion. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/currency/rates/versions
Parameters
Responses
|
Categories optimized for harmonization
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/harmonization/categories | |||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/harmonization/categories
Parameters
Responses
|
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).
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POST | /:organization/harmonization/landed-costs | 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 |
||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/harmonization/landed-costs
Body
Parameters
Responses
|
API to fetch HS-10 codes assigned to your items. Note that if your item has been classified multiple times or its classification has changed, this API will provide you with the most recent harmonization code for that item. That is, each code is unique across your item number, country of origin and destination.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | /:organization/harmonization/hs10 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/harmonization/hs10
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | /:organization/harmonization/hs10/versions | Provides visibility into recent changes of each object, including deletion |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET https://api.flow.io/:organization/harmonization/hs10/versions
Parameters
Responses
|
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.
Method and Path | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
POST | /:organization/tax/registrations | |||||||||||||||||||||||||||||||||||||||||||||
POST https://api.flow.io/:organization/tax/registrations
Body
Parameters
Responses
|
||||||||||||||||||||||||||||||||||||||||||||||
PUT | /:organization/tax/registrations/:key | |||||||||||||||||||||||||||||||||||||||||||||
PUT https://api.flow.io/:organization/tax/registrations/:key
Body
Parameters
Responses
|