Fast to Seller API (v1)

Download OpenAPI specification:Download

Fast: [email protected] URL: https://fast.co License: Fast Developer Terms

Authentication

ApiKeyAuth

Security Scheme Type	API Key
Header parameter name:	FASTSESSION

Fast to Seller API

Fast will communicate with your server application on these endpoints.

MerchantService

Create a specified type of an object/entity

Generic create interface

Request

Request Body schema: application/json

type	string (v1EntityType) The type of entity being created. Enum: "ENTITY_TYPE_UNSPECIFIED" "ENTITY_TYPE_ORDER" "ENTITY_TYPE_SHIPPING_OPTION" "ENTITY_TYPE_USER" "ENTITY_TYPE_SHIPPING_ZONES"
app_id	string The application ID for your store registered with Fast.
	object (v1CreateRequestSegment) Object containing the order information.
	object (v1UUID)

Responses

200

A successful response.

default

An unexpected error response.

post/fast/v1/create

Request samples

application/json

{"type": "ENTITY_TYPE_ORDER",
"order": {"is_cart": true,
"order": {"id": {"value": "eb3b8e18-930d-4213-92a0-4993f9e536a8"
},
"order_type": "ORDER_TYPE_CART",
"status": "ORDER_STATUS_CART",
"bill_to": { },
"lines": [{"id": {"value": "32dc17ee-ebff-40f8-87c5-b83f838d79d1"
},
"external_product_id": 112,
"quantity": 1,
"subtotal_amount": 0,
"tax_amount": 0,
"total_amount": 0
}
]
}
}
}

Response samples

200
default

application/json

{"order": {"order": {"id": {"value": "eb3b8e18-930d-4213-92a0-4993f9e536a8"
},
"external_id": "a98a387e-02ec-41a8-a38e-e3ca5fb0548d",
"order_type": 1,
"currency_code": "USD",
"bill_to": { },
"lines": [{"id": {"value": "32dc17ee-ebff-40f8-87c5-b83f838d79d1"
},
"external_id": "d3d6eca1-1697-4ad2-6f369364f75b"
}
],
"total_amount": 29.99,
"sub_total": 29.99,
"total_discounts": 0
}
}
}

Delete the specified object/entity

Generic delete interface

Request

Request Body schema: application/json

app_id	string The application ID for your store registered with Fast.
	object (v1UUID)
type	string (v1EntityType) Enum: "ENTITY_TYPE_UNSPECIFIED" "ENTITY_TYPE_ORDER" "ENTITY_TYPE_SHIPPING_OPTION" "ENTITY_TYPE_USER" "ENTITY_TYPE_SHIPPING_ZONES"
	object (v1DeleteOrderRequestSegment)

Responses

200

A successful response.

default

An unexpected error response.

post/fast/v1/delete

Request samples

application/json

{"app_id": "088fdade-8809-471c-89c2-f429fa844af2",
"type": "ENTITY_TYPE_ORDER",
"order": {"is_cart": true,
"external_id": "c8XyP8tIPIOluGmOgOv1D6bABUScTyvh"
}
}

Response samples

200
default

application/json

{"request_id": {"value": "string"
},
"type": "ENTITY_TYPE_UNSPECIFIED",
"order": { }
}

Read a specified type of an object/entity by provided id

This is a generic interface to read a specific type of an entity (e.g. order cart etc.).

Request

Request Body schema: application/json

app_id	string The application ID for your store registered with Fast.
	object (v1UUID) The idempotency key of request. Ensure that your operations are idempotent against this field
type	string (v1EntityType) Enum: "ENTITY_TYPE_UNSPECIFIED" "ENTITY_TYPE_ORDER" "ENTITY_TYPE_SHIPPING_OPTION" "ENTITY_TYPE_USER" "ENTITY_TYPE_SHIPPING_ZONES"
	object (v1ReadOrderRequestSegment) Object containing the order information.
shipping_zones	object (v1ReadShippingZonesRequestSegment) The geographical area (e.g. region ZIP code etc.) that physical goods will ship to.

Responses

200

A successful response.

default

An unexpected error response.

post/fast/v1/read

Request samples

application/json

{"app_id": "088fdade-8809-471c-89c2-f429fa844af2",
"type": "ENTITY_TYPE_ORDER",
"order": {"external_order_id": 585
}
}

Response samples

200
default

application/json

{"type": "ENTITY_TYPE_ORDER",
"order": {"order": {"external_id": 585,
"order_type": "ORDER_TYPE_ORDER",
"currency_code": "USD",
"bill_to": {"first_name": "Solutions",
"last_name": "Team",
"email": "[email protected]",
"phone": 18005551212,
"address_1": "100 Park Avenue",
"city_locality": "New York",
"state_province": "New York",
"state_province_code": "NY",
"country": "US",
"postal_code": 10017
},
"lines": [{"external_product_id": 1556,
"external_variant_id": 6418,
"quantity": 1,
"quantity_fulfilled": 0,
"unit_price": 22,
"discounted_unit_price": 0,
"line_discount_amount": 0,
"subtotal_amount": 22,
"tax_amount": 0,
"total_amount": 22,
"discounts": [{"applied": false
}
],
"name": "Radiant Tee",
"fulfillment_mode": "ITEM_FULFILLMENT_MODEL_PHYSICAL"
},
{"external_product_id": 1542,
"external_variant_id": 6419,
"quantity": 1,
"quantity_fulfilled": 0,
"unit_price": 0,
"discounted_unit_price": 0,
"line_discount_amount": 0,
"subtotal_amount": 0,
"tax_amount": 0,
"total_amount": 0,
"discounts": [{"applied": false
}
],
"name": "Radiant Tee-XS-Orange",
"fulfillment_mode": "ITEM_FULFILLMENT_MODEL_PHYSICAL"
},
{"external_product_id": 1556,
"external_variant_id": 6420,
"quantity": 1,
"quantity_fulfilled": 0,
"unit_price": 22,
"discounted_unit_price": 0,
"line_discount_amount": 0,
"subtotal_amount": 22,
"tax_amount": 0,
"total_amount": 22,
"discounts": [{"applied": false
}
],
"name": "Radiant Tee",
"fulfillment_mode": "ITEM_FULFILLMENT_MODEL_PHYSICAL"
},
{"external_product_id": 1548,
"external_variant_id": 6421,
"quantity": 1,
"quantity_fulfilled": 0,
"unit_price": 0,
"discounted_unit_price": 0,
"line_discount_amount": 0,
"subtotal_amount": 0,
"tax_amount": 0,
"total_amount": 0,
"discounts": [{"applied": false
}
],
"name": "Radiant Tee-M-Orange",
"fulfillment_mode": "ITEM_FULFILLMENT_MODEL_PHYSICAL"
}
],
"shipment_plans": [{"id": {"value": "me"
},
"external_id": "me",
"ship_to": {"first_name": "Solutions",
"last_name": "Team",
"email": "[email protected]",
"phone": 18005551212,
"address_1": "100 Park Avenue",
"city_locality": "New York",
"state_province": "New York",
"state_province_code": "NY",
"country": "US",
"postal_code": 10017
},
"lines": [{"quantity": 1,
"external_id": 998
},
{"quantity": 1,
"external_id": 999
},
{"quantity": 1,
"external_id": 1000
},
{"quantity": 1,
"external_id": 1001
}
],
"selected_option": {"external_id": "flatrate_flatrate",
"name": "Flat Rate - Fixed",
"cost": 10,
"tax": 0,
"total": 10
},
"available_options": null
}
],
"total_amount": 54,
"sub_total": 44,
"total_discounts": 0,
"total_tax": 0,
"total_shipping": 10,
"short_order_id": 585
}
},
"user": {"user": {"email": "[email protected]",
"first_name": "Solutions",
"last_name": "Team",
"phone": 18005551212
}
}
}

Update identified object/entity

Generic update interface

Request

Request Body schema: application/json

app_id	string The application ID for your store registered with Fast.
	object (v1UUID)
type	string (v1EntityType) Enum: "ENTITY_TYPE_UNSPECIFIED" "ENTITY_TYPE_ORDER" "ENTITY_TYPE_SHIPPING_OPTION" "ENTITY_TYPE_USER" "ENTITY_TYPE_SHIPPING_ZONES"
	object (v1UpdateOrderRequestSegment)

Responses

200

A successful response.

default

An unexpected error response.

post/fast/v1/update

Request samples

application/json

{"app_id": "31d7ff3a-0128-440e-a5a2-c1e10d4c2d83",
"type": "ENTITY_TYPE_ORDER",
"order": {"order_id": {"value": "863e151e-703e-4da3-b044-a1c874afeda3"
},
"is_cart": true,
"items": [{"item_id": {"value": "e0400168-958b-4a46-bf23-08cb6ee00630",
"quanity": 1
},
"external_product_id": "canon-powershot-a580M",
"external_variant_id": "canon-powershot-a580M",
"external_item_id": "6f396ac44ded0ef59626a2a3f5"
}
],
"external_id": "b097a63a4f829c6ecc192c3057"
}
}

Response samples

200
default

application/json

{"type": "ENTITY_TYPE_ORDER",
"order": {"order": {"id": {"value": "863e151e-703e-4da3-b044-a1c874afeda3"
},
"external_id": "b097a63a4f829c6ecc192c3057",
"order_type": "ORDER_TYPE_CART",
"currency_code": "USD",
"status": "ORDER_STATUS_CART",
"bill_to": {"first_name": "Solutions",
"last_name": "Team",
"email": "[email protected]",
"phone": 18005551212,
"address_1": "100 Park Avenue",
"city_locality": "New York",
"state_province_code": "NY",
"country_code": "US",
"postal_code": 10017
},
"lines": [{"id": {"value": "2f914efb-0926-46af-86b4-6f7012d3d9bd"
},
"external_id": "dc8a000b11e0ac1bd81ed6427a",
"external_product_id": "canon-eos-50d-bodyM",
"external_variant_id": "canon-eos-50d-bodyM",
"quantity": 1,
"quantity_fulfilled": 1,
"unit_price": 979.99,
"discounted_unit_price": 979.99,
"line_discount_amount": 0,
"subtotal_amount": 979.99,
"tax_amount": 49,
"total_amount": 979.99,
"name": "Canon EOS 50D Digital SLR Camera (body only)",
"description": "Canon EOS 50D Digital SLR Camera (body only)",
"image_url": "https://edge.disstg.commercecloud.salesforce.com/dw/image/v2/ZYBW_002/on/demandware.static/-/Sites-electronics-m-catalog/default/dwc16ea6c4/images/medium/canon-eos-50d-body.jpg",
"fulfillment_mode": "ITEM_FULFILLMENT_MODEL_PHYSICAL"
},
{"id": {"value": "e0400168-958b-4a46-bf23-08cb6ee00630"
},
"external_id": "6f396ac44ded0ef59626a2a3f5",
"external_product_id": "canon-powershot-a580M",
"external_variant_id": "canon-powershot-a580M",
"quantity": 1,
"quantity_fulfilled": 1,
"unit_price": 149.99,
"discounted_unit_price": 149.99,
"line_discount_amount": 0,
"subtotal_amount": 149.99,
"tax_amount": 7.5,
"total_amount": 149.99,
"name": "Canon PowerShot A580 Digital Point and Shoot Camera",
"description": "Canon PowerShot A580 Digital Point and Shoot Camera",
"image_url": "https://edge.disstg.commercecloud.salesforce.com/dw/image/v2/ZYBW_002/on/demandware.static/-/Sites-electronics-m-catalog/default/dwc1815b35/images/medium/canon-powershot-a580.jpg",
"fulfillment_mode": "ITEM_FULFILLMENT_MODEL_PHYSICAL"
}
],
"shipment_plans": [{"id": {"value": "me"
},
"external_id": "me",
"ship_to": {"first_name": "Solutions",
"last_name": "Team",
"email": "[email protected]",
"phone": 18005551212,
"address_1": "100 Park Avenue",
"city_locality": "New York",
"state_province_code": "NY",
"country_code": "US",
"postal_code": 10017
},
"lines": [{"id": {"value": "2f914efb-0926-46af-86b4-6f7012d3d9bd"
},
"quantity": 1,
"external_id": "dc8a000b11e0ac1bd81ed6427a"
},
{"id": {"value": "e0400168-958b-4a46-bf23-08cb6ee00630"
},
"quantity": 1,
"external_id": "6f396ac44ded0ef59626a2a3f5"
}
],
"selected_option": {"external_id": 1,
"name": "Ground",
"shipment_type": "SHIPPING_OPTION_TYPE_OTHER",
"cost": 15.19,
"tax": 0.8,
"total": 15.99
},
"available_options": [{"external_id": 1,
"name": "Ground",
"shipment_type": "SHIPPING_OPTION_TYPE_OTHER",
"cost": 15.99,
"tax": 0,
"total": 15.99,
"service_level": "Order received within 7-10 business days"
},
{"external_id": 2,
"name": "2-Day Express",
"shipment_type": "SHIPPING_OPTION_TYPE_OTHER",
"cost": 20.99,
"tax": 0,
"total": 20.99,
"service_level": "Order received in 2 business days"
},
{"external_id": 3,
"name": "Overnight",
"shipment_type": "SHIPPING_OPTION_TYPE_OTHER",
"cost": 29.99,
"tax": 0,
"total": 29.99,
"service_level": "Order received the next business day"
}
]
}
],
"total_amount": 1203.27,
"sub_total": 1129.98,
"total_discounts": 0,
"total_tax": 57.3,
"total_shipping": 15.99
}
}
}