Seller to Fast API (V1)

Download OpenAPI specification:Download

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: FASTSESSION

Seller to Fast API

Seller to Fast API

Order Management Service

Get Order by Fast id

Get Order by Fast id

path Parameters
order_id.value
required
string

UUID value

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "order": {
    }
}

Cancel Order by Fast id

Cancel Order by Fast id

path Parameters
order_id.value
required
string

UUID value

Request Body schema: application/json
object (Typed UUID)
reason
string (v1CancelReasonCode)
Default: "CANCEL_REASON_CODE_UNSPECIFIED"
Enum: "CANCEL_REASON_CODE_UNSPECIFIED" "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

Request samples

Content type
application/json
{
  • "order_id": {
    },
  • "reason": "CANCEL_REASON_CODE_UNSPECIFIED",
  • "notes": "string"
}

Response samples

Content type
application/json
{ }

Send a business event

Inform Fast regarding a order related business event that happened

path Parameters
order_id.value
required
string

UUID value

Request Body schema: application/json
object (Typed UUID)
event_type
string (v1BusinessEventType)
Default: "BUSINESS_EVENT_TYPE_UNSPECIFIED"
Enum: "BUSINESS_EVENT_TYPE_UNSPECIFIED" "BUSINESS_EVENT_TYPE_FULFILLMENT" "BUSINESS_EVENT_TYPE_CLEAR_TO_COLLECT_PAYMENT"
object (v1OrderFulfillmentEvent)

Responses

Request samples

Content type
application/json
{
  • "order_id": {
    },
  • "event_type": "BUSINESS_EVENT_TYPE_UNSPECIFIED",
  • "fulfillment": {
    }
}

Response samples

Content type
application/json
{ }

Refund by Order id

Refund by Order id

path Parameters
order_id.value
required
string

UUID value

Request Body schema: application/json
object (Typed UUID)
refund_id
string
reason
string (v1RefundReasonCode)
Default: "REFUND_REASON_CODE_UNSPECIFIED"
Enum: "REFUND_REASON_CODE_UNSPECIFIED" "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)
Default: "REFUND_METHOD_UNSPECIFIED"
Enum: "REFUND_METHOD_UNSPECIFIED" "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

Request samples

Content type
application/json
{
  • "order_id": {
    },
  • "refund_id": "string",
  • "reason": "REFUND_REASON_CODE_UNSPECIFIED",
  • "note": "string",
  • "method": "REFUND_METHOD_UNSPECIFIED",
  • "amount": "string",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "order_lines": [
    ]
}

Response samples

Content type
application/json
{ }