Seller to Fast 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

Seller to Fast API

Order Management Service

Get Order by Fast id

Request

path Parameters

order_id.value

required

string

UUID value

Responses

200

A successful response.

default

An unexpected error response.

get/v1/external/orders/{order_id.value}

Request samples

curl -i -X GET \
  'https://api.fast.co/v1/external/orders/{order_id.value}'

Response samples

200
default

application/json

{"order": {"id": {"value": "string"
},
"external_id": "string",
"user_id": "string",
"order_type": "ORDER_TYPE_CART",
"currency_code": "string",
"status": "ORDER_STATUS_CART",
"bill_to": {"id": {"value": "string"
},
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"company": "string",
"email": "string",
"phone": "string",
"address_1": "string",
"address_2": "string",
"city_locality": "string",
"state_province": "string",
"state_province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string"
},
"lines": [{"id": {"value": "string"
},
"external_id": "string",
"external_product_id": "string",
"external_variant_id": "string",
"external_options": [{"key": "string",
"value": "string"
}
],
"customizations": [{"key": "string",
"value": "string"
}
],
"quantity": 0,
"quantity_fulfilled": 0,
"unit_price": "string",
"discounted_unit_price": "string",
"line_discount_amount": "string",
"subtotal_amount": "string",
"tax_amount": "string",
"total_amount": "string",
"discounts": [{"code": "string",
"description": "string",
"origin": "DISCOUNT_ORIGIN_USER",
"type": "DISCOUNT_TYPE_MISC",
"applied": true,
"total_amount": "string"
}
],
"name": "string",
"description": "string",
"image_url": "string",
"fulfillment_mode": "ITEM_FULFILLMENT_MODEL_PHYSICAL"
}
],
"shipment_plans": [{"id": {"value": "string"
},
"external_id": "string",
"ship_to": {"id": {"value": "string"
},
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"company": "string",
"email": "string",
"phone": "string",
"address_1": "string",
"address_2": "string",
"city_locality": "string",
"state_province": "string",
"state_province_code": "string",
"country": "string",
"country_code": "string",
"postal_code": "string"
},
"lines": [{"id": {"value": "string"
},
"quantity": 0
}
],
"selected_option": {"id": {"value": "string"
},
"external_id": "string",
"name": "string",
"shipment_type": "SHIPPING_OPTION_TYPE_IN_STORE_PICKUP",
"cost": "string",
"tax": "string",
"total": "string",
"carrier": "string",
"service_level": "string"
},
"available_options": [{"id": {"value": "string"
},
"external_id": "string",
"name": "string",
"shipment_type": "SHIPPING_OPTION_TYPE_IN_STORE_PICKUP",
"cost": "string",
"tax": "string",
"total": "string",
"carrier": "string",
"service_level": "string"
}
],
"shipments": [{"carrier": "string",
"tracking_number": "string",
"estimated_delivery_date": "string",
"lines": [{"id": null,
"quantity": null
}
]
}
]
}
],
"coupons": [{"code": "string",
"description": "string",
"origin": "DISCOUNT_ORIGIN_USER",
"type": "DISCOUNT_TYPE_MISC",
"applied": true,
"total_amount": "string"
}
],
"total_amount": "string",
"sub_total": "string",
"total_discounts": "string",
"total_tax": "string",
"total_shipping": "string",
"refunds": [{"id": {"value": "string"
},
"external_id": "string",
"reason": "string",
"use_original_method": true,
"lines": [{"id": {"value": "string"
},
"quantity": 0
}
],
"refund_date": "string",
"amount": "string",
"tax": "string",
"shipping": "string"
}
],
"custom_values": [{"key": "string",
"value": "string"
}
],
"user_note": "string",
"store_note": "string",
"fast_note": "string"
}
}

Cancel Order by Fast id

Request

path Parameters

order_id.value

required

string

UUID value

Request Body schema: application/json

	object (v1UUID)
reason	string (v1CancelReasonCode) Enum: "CANCEL_REASON_CODE_CUSTOMER_INITIATED" "CANCEL_REASON_CODE_MERCHANT_INITIATED" "CANCEL_REASON_CODE_NO_STOCK" "CANCEL_REASON_CODE_BAD_CONFIG" "CANCEL_REASON_CODE_OTHER"
notes	string Any additional notes associated with the cancellation.

Responses

200

A successful response.

default

An unexpected error response.

post/v1/external/orders/{order_id.value}

Request samples

application/json

{"order_id": {"value": "string"
},
"reason": "CANCEL_REASON_CODE_CUSTOMER_INITIATED",
"notes": "string"
}

Response samples

200
default

application/json

{ }

Send a business event

Inform Fast regarding a order related business event that happened

Request

path Parameters

order_id.value

required

string

UUID value

Request Body schema: application/json

	object (v1UUID)
event_type	string (v1BusinessEventType) Enum: "BUSINESS_EVENT_TYPE_FULFILLMENT" "BUSINESS_EVENT_TYPE_CLEAR_TO_COLLECT_PAYMENT"
	object (v1OrderFulfillmentEvent)

Responses

200

A successful response.

default

An unexpected error response.

post/v1/external/orders/{order_id.value}/business_event

Request samples

application/json

{"order_id": {"value": "string"
},
"event_type": "BUSINESS_EVENT_TYPE_FULFILLMENT",
"fulfillment": {"order_id": {"value": "string"
},
"shipment": {"tracking_number": "string",
"carrier": "string",
"estimated_delivery_date": "string",
"order_lines": [{"id": {"value": "string"
},
"quantity": "string"
}
]
},
"status": "ORDER_STATUS_CART"
}
}

Response samples

200
default

application/json

{ }

Refund by Order id

Request

path Parameters

order_id.value

required

string

UUID value

Request Body schema: application/json

	object (v1UUID)
external_refund_id	string Id provided by the seller to tie back the refund on their end. Should be unique for each refund.
reason	string (v1RefundReasonCode) Enum: "REFUND_REASON_CODE_UNSATISFIED" "REFUND_REASON_CODE_WRONG_OPTION" "REFUND_REASON_CODE_WRONG_PRODUCT" "REFUND_REASON_CODE_DAMAGED_PRODUCT" "REFUND_REASON_CODE_NOT_DELIVERED" "REFUND_REASON_CODE_WRONG_TAX" "REFUND_REASON_CODE_WRONG_SHIPPING" "REFUND_REASON_CODE_OVERCHARGE" "REFUND_REASON_CODE_COURTESY" "REFUND_REASON_CODE_OTHER"
note	string
method	string (v1RefundMethod) Enum: "REFUND_METHOD_STORE_CREDIT" "REFUND_METHOD_ORIGINAL_METHOD"
amount	string Should be a float value. Ex: "42.00"
tax_amount	string Should be a float value. Ex: "42.00"
shipping_amount	string Should be a float value. Ex: "42.00"
	Array of objects (v1RefundOrderLineContext)

Responses

200

A successful response.

default

An unexpected error response.

post/v1/external/orders/{order_id.value}/refund

Request samples

application/json

{"order_id": {"value": "string"
},
"external_refund_id": "string",
"reason": "REFUND_REASON_CODE_UNSATISFIED",
"note": "string",
"method": "REFUND_METHOD_STORE_CREDIT",
"amount": "string",
"tax_amount": "string",
"shipping_amount": "string",
"order_lines": [{"line": {"id": {"value": "string"
},
"quantity": "string"
},
"reason": "REFUND_REASON_CODE_UNSATISFIED"
}
]
}

Response samples

200
default

application/json

{ }