common 0.0.12

The Flow Commerce REST API provides full access to the global ecommerce platform.

Resources

healthcheck

Operations

Method and Path Description
GET /_internal_/healthcheck

Headers

No headers

Imports

No imports

Enums

calendar

Name Value Description
weekdays weekdays

Mon - Fri

everyday everyday

7 days per week

capability

Name Value Description
crossdock crossdock

change_type

Name Value Description
insert insert

update update

delete delete

dimension_type

Specifies the difference between product dimensions and the actual packaged dimensions. This enables us to generate more accurate shipping estimates based on the packaged dimensions. The common example is a scarf which may have product dimensions of 6 feet long even though it can be folded to have very small package dimensions.

Name Value Description
product product

The standalone dimensions of an item.

package package

The boxed dimensions of an item.

exception_type

Name Value Description
open open

closed closed

holiday_calendar

Name Value Description
us_bank_holidays us_bank_holidays

jewish_holidays jewish_holidays

schedule_exception_status

Pending better name

Name Value Description
Open Open

Closed Closed

sort_direction

Name Value Description
ascending ascending

descending descending

unit_of_measurement

Defines the units of measurement that we support. As units are added, we conform with the standard units provided by jscience as part of JSR 363 - see http://jscience.org/api/javax/measure/unit/SI.html and http://jscience.org/api/javax/measure/unit/NonSI.html

Name Value Description
millimeter millimeter

Equivalent to MILLI(METRE).

centimeter centimeter

Equivalent to CENTI(METRE).

inch inch

A unit of length equal to 0.01004 m (standard name in).

foot foot

A unit of length equal to 0.3048 m (standard name ft).

cubic_inch cubic_inch

A unit of volume equal to one cubic inch (in³).

cubic_meter cubic_meter

The metric unit for volume quantities (m³).

gram gram

A unit of mass equal to 1 / 1000 kilogram (standard name g).

kilogram kilogram

The base unit for mass quantities (kg).

meter meter

The base unit for length quantities (m).

ounce ounce

A unit of mass equal to 1 / 16 POUND (standard name oz).

pound pound

A unit of mass equal to 453.59237 grams (avoirdupois pound, standard name lb).

unit_of_time

Defines the units of time that we support. We confirm with the standard set of units of time from http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html

Name Value Description
day day

hour hour

minute minute

value_added_service

Name Value Description
Hazardous Material Hazardous Material

See https://en.wikipedia.org/wiki/ORM-D

visibility

Name Value Description
public public

private private

Models

contact

Example Json: Minimal | Full

Defines structured fields for a contact person. Typically used for specifying contact person for an account, shipment, or organization representative

Field Type Required? Default Description
name name Yes -

email string No -

phone string No -

datetime_range

Example Json: Minimal | Full
Field Type Required? Default Description
from date-time-iso8601 Yes -

to date-time-iso8601 Yes -

dimension

Example Json: Minimal | Full
Field Type Required? Default Description
type dimension_type Yes -

depth measurement No -

length measurement No -

weight measurement No -

width measurement No -

error

Example Json: Minimal | Full
Field Type Required? Default Description
code string Yes -

Machine readable code for this specific error message

message string Yes -

Description of the error

exception

Example Json: Minimal | Full

Represents an exception to the schedule of a location.

Field Type Required? Default Description
type exception_type Yes -

datetime_range datetime_range Yes -

Range for the holiday. For single-day holidays, from and to should just be the same.

Example: 2016/12/24 12:00 am to 2016/12/25 11:59 pm

experience_summary

Example Json: Minimal | Full

Some important fields related to experiences used in various APIs

Field Type Required? Default Description
id string Yes -

key string Yes -

name string Yes -

currency string No -

Standard currency to use for prices on this shipping experience

country string No -

Destination country for this shipping experience

healthcheck

Example Json: Minimal | Full
Field Type Required? Default Description
status string Yes -

Example: healthy

location

Example Json: Minimal | Full

Defines structured fields for address to be used in user/form input. Either text or the structured input needs to be present.

Field Type Required? Default Description
text string No -

Full text version of address

streets [string] No -

Array for street line 1, street line 2, etc., in order

city string No -

province string No -

postal string No -

country string No -

The ISO 3166-3 country code. Case insensitive. See https://reference.api.flow.io/countries

Example: USA

latitude string No -

longitude string No -

location_reference

Example Json: Minimal | Full
Field Type Required? Default Description
text string No -

Full text version of address

measurement

Example Json: Minimal | Full
Field Type Required? Default Description
value string Yes -

Example: 12.23

units unit_of_measurement Yes -

Example: inch

name

Example Json: Minimal | Full
Field Type Required? Default Description
first string No -

last string No -

organization

Example Json: Minimal | Full

Represents a single organization in the system

Field Type Required? Default Description
id string Yes -

name string Yes -

organization_reference

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

organization_summary

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

name string Yes -

schedule

Example Json: Minimal | Full

Represents operating calendar and holidays of a location

Field Type Required? Default Description
calendar calendar No -

Operating calendar used by origin location for shipment, if avialable. If not provided, assume they are never open.

Example: Weekdays, 7 days, etc.

holiday holiday_calendar Yes -

Standard holiday set to respect for this schedule

Example: US bank holidays

exception [exception] Yes -

Holiday calendar used by origin location for shipment, if avialable.

Example: Memorial Day, Independence Day, etc.

cutoff string No -

Daily cutoff time for shipment fulfillment at origin location, if available. 24-hour time

Example: 16:45

user

Example Json: Minimal | Full

Represents a single user in the system

Field Type Required? Default Description
id string Yes -

email string No -

If known, the user’s primary email address. While in most common cases, we expect users to have email addresses, there are edge cases where it is useful to allow a user to NOT have an email address. For example, users interacting solely from mobile devices, guest user accounts, initial onboarding where email is not known, etc. We think by starting off with an optional primary email address we can support these use cases with very little implementation cost.

name name Yes -

The user’s name.

user_reference

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

user_summary

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

email string No -

name string Yes -

Unions

expandable_location

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
location location Minimal | Full

location_reference location_reference Minimal | Full

expandable_organization

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
organization organization Minimal | Full

organization_reference organization_reference Minimal | Full

expandable_user

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
user user Minimal | Full

user_reference user_reference Minimal | Full

Annotations

No annotations