GET /transactions/{id}.json

GET /transactions/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • amount number Required

      Amount

      Default value is 0.

    • baseAmount number | null

      Base amount

    • createdAt string(date-time)

      Created at

    • createdSource string | null Required

      Created source

      Values are manual or catchup. Default value is manual.

    • dropshipmentId integer(int32) | null

      Dropshipment

    • externalId string Required

      External

    • fulfillmentId integer(int32) | null

      Fulfillment

    • id integer(int32)

      Id

    • name string Required

      Name

    • processingFee number | null Required

      Processing fee

      Default value is 0.

    • purchaseId integer(int32) | null

      Purchase

    • purchaseInvoiceId integer(int32) | null

      Purchase invoice

    • purchasedAt string(date-time) | null

      Purchased at

    • refundAmount number Required

      Refund amount

      Default value is 0.

    • returnShipmentId integer(int32) | null

      Return shipment

    • saleReturnId integer(int32) | null

      Sale return

    • shippingIntegrationId integer(int32) | null

      Shipping integration

    • shippingRateCacheId integer(int32) | null

      Shipping rate cache

    • source string | null Required

      Source

      Values are farfetch:postmen, jetti, postmen, shippingIntegration, shippo, shippyPro, or shipStation. Default value is jetti.

    • status string | null Required

      Status

      Values are pending, complete, error, or cancelled. Default value is pending.

    • stripeId string | null

      Stripe

    • stripeRefundId string | null

      Stripe refund

    • transferId integer(int32) | null

      Transfer

    • type string Required

      Type

      Values are farfetch:postmen, postmen, shippo, shippyPro, shipStation, or stripe.

    • updatedAt string(date-time)

      Updated at

GET /transactions/{id}.json
curl \
 --request GET 'http://api.example.com/v1/transactions/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "amount": 0,
  "baseAmount": 42.0,
  "createdAt": "2025-05-04T09:42:00Z",
  "createdSource": "manual",
  "dropshipmentId": 42,
  "externalId": "string",
  "fulfillmentId": 42,
  "id": 42,
  "name": "string",
  "processingFee": 0,
  "purchaseId": 42,
  "purchaseInvoiceId": 42,
  "purchasedAt": "2025-05-04T09:42:00Z",
  "refundAmount": 0,
  "returnShipmentId": 42,
  "saleReturnId": 42,
  "shippingIntegrationId": 42,
  "shippingRateCacheId": 42,
  "source": "jetti",
  "status": "pending",
  "stripeId": "string",
  "stripeRefundId": "string",
  "transferId": 42,
  "type": "farfetch:postmen",
  "updatedAt": "2025-05-04T09:42:00Z"
}