Reference Types

Shared types are used where the same structure of data appears in more than one data type.
Reference date types (ending with Ref) link between data types in the Railz Commerce API endpoints.

FulfillmentRefs

Found on:

FieldTypeDescription
carrierstringThe shipping company.
trackingNumberstringTracking number associated with the order parcel.
servicestringThe shipping service e.g. priority mail, 2 day delivery, etc.
trackingUrlstringThe tracking URL that the buyer can click to check tracking details.

RefundRefs

Found on:

FieldTypeDescription
idstringUnique Identifier of the refund transaction.
totalAmountdecimalThe total amount to be refunded.

TransactionSourceRefs

Found on:

Field

Type

Description

id

string

Unique Identifier of the source transaction

type

string

Type of the transaction:
failedPayout
payment
paymentFee
paymentFeeRefund
payout
refund
transfer
dispute
order
other
unknown

totalAmount

decimal

Total amount of the transaction.

CustomerRef

Found on:

FieldTypeDescription
idstringIdentifier for the customer, unique to the business in the commerce platform.
customerNamestringFirst Name +' '+ Last Name of the customer as recorded in the commerce platform.
emailstringCustomer’s primary email address.

CurrencyRef

Found on:

FieldTypeDescription
idstringIdentifier for the currency, unique to the business in the commerce platform. Can be similar to symbol for some providers.
symbolstringA three letter string representing the ISO-4217 code for the currency.
namestringFull name of the currency e.g. Canadian Dollars

Address

Found on:

FieldTypeDescription
contactNamestringThe name of the contact person associated with the address.
phonestringThe phone number at the address.
line1stringLine 1 of the address.
line2stringLine 2 of the address.
citystringCity of the address.
regionstringRegion of the address.
countrystringCountry of the address as 3 ISO alpha-3 characters.
postalCodestringPostal code or zip code of the address.

LocationRef

Found on:

FieldTypeDescription
idstringid' unique to the product or order - from the Locations data type
namestringname' from the Locations data type