These resources mirror the official documentation located at docs.flow.io.
| Resource | Description |
|---|---|
| addressConfigurations | |
| allocations | |
| attributes | 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. |
| catalogs | |
| checkoutAttributes | 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. |
| checkoutItemContents | A Checkout Item Content provides information about an item to support rendering of that item in the context of checkout |
| creditPayments | 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. |
| discountRuleSettings | |
| experiences | Experiences define a local experience for a given geographic region |
| experienceCheckoutSettings | |
| experienceDefaults | Defines a set of defaults for a given organization and region |
| experienceLogisticsSettings | Controls logistics related settings per experience |
| experiencePriceConversions | |
| experiencePriceFacetConversions | |
| items | The Flow item defines a specific item that can be purchased by a consumer. For many clients, this will map to a Sku. |
| itemFormOverlays | The item form overlay defines data to merge into an item form. |
| orders | 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. |
| orderBuilders | 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 |
| orderEstimates | Lightweight estimate for a group of items without any customer-related information. This will contain available estimates on shipping, taxes, and duties. |
| orderIdentifiers | 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. |
| orderNumberGenerators | |
| orderPromotions | |
| orderSummaries | The order summary is a view of the order summary object with the order prices flattened to keys. |
| organizations | |
| paymentMethodRules | Returns payment methods that are enabled for an organization and available for the provided country and currency. |
| priceBooks | |
| priceBookItems | |
| subcatalogs | A configuration with custom query to select a subset of master catalog items for a localized experience |
| subcatalogItems | Represents information specific to an item in a given subcatalog |
| organizationCurrencySettings | Represents organization-specific currency conversion adjustments. |
| rates | Represents an organization-specific currency conversion rate at a point in time. |
| harmonizedCategories | Categories optimized for harmonization |
| harmonizedLandedCosts | 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). |
| hs10 | 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. |
| taxRegistrations | 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. |
| authorizations | |
| captures | 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). |
| cards | 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 |
| cardPaymentSources | Represents a saved credit card payment method. |
| gatewayAuthenticationData | |
| payments | Represents data for a specific online payment method |
| publicKeys | A public key is used to encrypt cards client side prior to submitting to the Flow vault. |
| refunds | 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). |
| reversals | A reversal is used to clear an authorization (full or partial). |
| virtualCards | Virtual credit cards are created for a specific limit and currency. Currently only USD denominated cards can be issued. Once created the virtual card can be used in the same way as a physical credit card using the card number, cvv and expiration details. |
| virtualCardCaptures | Payment has been captured for the virtual credit card |
| virtualCardRefunds | A refund has been issued for the virtual credit card |
| centers | Represents a facility capable of fulfilling a shipment |
| deliveryWindows | 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. |
| dimensionEstimates | |
| inventoryRules | Ordered list of rules to apply, from first to last, to get available quantity. This is unique per organization |
| inventorySnapshots | Inventory snapshot reflects the current quantity and available number of units for a given center / item |
| inventoryUpdates | Represents a single update on inventory quantity |
| manifests | Represents closeout of a group of labels that have been transferred to the carrier for shipping |
| quotes | Represents a collection of deliveries and available options for fulfillment of that delivery |
| ratecards | Snapshot of all lanes and rows across all service levels of an organization |
| ratecardEstimates | |
| ratecardLanes | Describe list of rates applicable for a lane on the ratecard - defined by origin and destination zone |
| ratecardRates | Specific line item in a ratecard lane with information on a weight threshold and corresponding amount to charge |
| returns | |
| shippingConfigurations | |
| shippingConfigurationCopies | |
| shippingLabels | Represents information about a carrier-generated shipping label used by a shipper to transport a package from a given origin to destination |
| shippingNotifications | 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. |
| surchargeSettings | |
| tiers | Service shipping tier available in this tier group. e.g. Standard tier, Express tier, Economy tier |
| trackings | 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 |
| trackingEvents | |
| trackingLabels | Represents a specific label being tracked as part of the tracking bucket |
| webhooks | |
| webhookDeliveries | 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. |
| webhookSettings | 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. |
| addresses | |
| countryDefaults | Provides country level defaults, incl language and currency. This resource allows you to provide geo info (e.g. IP, address, country) and will geolocate the request, returning the matching country level defaults. For example, if a user lands on your website and you do not have any stored preferences, you can use this API to retrieve the best default preferences based on the location of the user by providing their IP Address. |
| timezones | Time zone data is provided by the public IANA time zone database. See http://www.iana.org/time-zones |
| carriers | Partner that actually takes a shipment between places (ex: FedEx, DHL, SF Express) |
| carrierServices | Specific service rendered by the carrier (fedex ground saturday, ups overnight weekend, etc) |
| countries | 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 |
| currencies | ISO 4217 3-character currency code. See https://api.flow.io/reference/currencies |
| languages | ISO 639 2-character language code. See https://api.flow.io/reference/languages |
| locales | Locales defines standard conventions for presentation of content. See https://api.flow.io/reference/locales |
| paymentMethods | Represents a single payment method - e.g VISA or Paypal - and any associated metadata required for processing |
| provinces | 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 |
| regions | 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 |
| abandonedOrderSettings | |
| b2bCreditMemos | The b2b credit memo represents a refund transaction between Flow and one of our clients |
| b2bInvoices | The b2b invoice represents a transaction between Flow and one of our clients (e.g. Flow purchasing inventory to resell to a consumer). |
| catalogPriceBookItemDocuments | Represents the returned information for searching particular price book items |
| checkoutTokens | Represents a secure token that can be used to redirect to Checkout UI |
| consumerInvoices | 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. |
| consumerInvoiceDocuments | |
| countryPickers | The Country Picker manages the configuration of your country picker. |
| creditMemos | The credit memo represents the details of a refund and the reasons for the issuance of the refund. |
| customers | A customer represents the actual person placing an order. |
| customerAddressBook | A composed model representing a customer's address book contacts. |
| customerAddressBookContacts | Preferences may indicate a contact is preferred for billing, invoicing, and/or shipping. |
| customerBundles | A bundle of all the content needed to render customer data. |
| customerPurgeSettings | Represent settings for when to purge customer data |
| customerTokens | Represents a mapping between a customer number and a token |
| documents | |
| ecommercePlatforms | The Ecommerce Platform defines what the organization is using for their ecommerce systems. |
| emailVerifications | 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. |
| exclusionRules | A global exclusion rule allows the user to select 1 or more items by query and to globally exclude those items from sale in one or more regions. |
| exports | |
| flowRoles | Default user roles supported by Flow |
| fraudEmailRules | Rule to apply to enable white-listing and black-listing for an email address. |
| ftpFiles | The FTP File represents a file uploaded to the FTP Server |
| ftpFolders | The FTP Folder represents a single folder associated with an organization for which we create an external FTP Directory |
| ftpOrganizationSettings | 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. |
| fulfillments | Used to track and manage the fulfillment of an order. |
| healthchecks | |
| imports | |
| importTemplates | |
| invitations | 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. |
| priceRules | |
| itemQuerySuggestions | |
| links | |
| memberships | 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 |
| merchantGiftCardBalances | |
| merchantGiftCardRedemptions | |
| merchantGiftCardReversals | |
| organizationAuthorizations | Defines the data used for broad authorization of user access to org level data |
| organizationDefaultConfigurations | |
| organizationTokens | All of the metadata associated with a given token. |
| partnerTokens | All of the metadata associated with a given token. |
| passwordResetForms | |
| permissionChecks | Used to test an integration's permissions, including identifying the authentication technique that will be used for similar requests. |
| scheduledExports | |
| sessions | |
| sessionAuthorizations | |
| shopifyCarts | Cart actions are based off the Shopify Ajax API, documentation at https://help.shopify.com/themes/development/getting-started/using-ajax-api |
| shopifyCartConversions | Shopify cart conversions create representations of cart data for Shopify based on a given experience. Cart actions are based off the Shopify Ajax API, documentation at https://help.shopify.com/themes/development/getting-started/using-ajax-api |
| shopifyLocalizationSettings | |
| shopifyLocationFlowCenterMappings | |
| shopifyPrivateApps | Shopify private app information. |
| shopifySyncStatuses | |
| suggestions | |
| syncPendingRecords | |
| syncRecords | |
| syncRecordFailures | |
| syncStreams | |
| taxSettings | |
| tokens | |
| tokenValidations | Validations test whether or not a given API token is valid |
| uploads | Provides the ability to upload a file to a URL (an expiring s3 url, usually valid for 1 week) |
| users |