Retrieve transfers orders (TO)

get https://{env}.gainsystems.com/api/v1/replenishment/transfer-orders

Retrieve recommended transfer orders (TO) derived from GAINS replenishment calculations

Responses

Response body

object

DataType

string

Defaults to transfer_order

States the type of records in this payload

Data

array of objects

Data

object

TrackingNumber

string

The GAINS tracking number associated with the transfer order

ShippingLocation

string

The shipping location for the transfer order (identifies the internal location)

ReceivingLocation

string

The receiving location for the transfer order

SenderName

string

The name of the sending location (identified as the ShippingLocation)

ReleaseDate

date

The recommended transfer order release date

RequestedDeliveryDate

date

The requested delivery date for the transfer order

SubmittedBy

string

The user that submitted the order

Documentation

string

Additonal header level notes and documentation

ContactName

string

Transferring location contact name

ContactEmail

string

Transferring location contact email

ShipMethod

string

Describes the shipping method for this order

Address1

string

Transferring location address line 1

Address2

string

Transferring location address line 2

Address3

string

Transferring location address line 3

City

string

Transferring location city

State

string

Transferring location state

PostalCode

string

Transferring location postal code

Country

string

Transferring location country

UpdatedTime

date-time

The Y-m-d H:i:s representation of when this line item was updated (uses server timezone)

LineItems

array of objects

LineItems

object

ItemCode

string

Item code

ItemDescription

string

The description of the item

Quantity

integer

The quantity (adjusted) of the item being transferred

QuantityUnadjusted

integer

The quantity of the item being transferred

Cost

number

The unit cost of this SKUL

LineComment

string

Any comments associated with the line item

OrderNumber

string

Unique order identifier

OrderType

string

Order type classification

DeliveryDate

date

The Y-m-d representation of when this line item was delivered

LineNumber

string

Unique line identifier (if applicable)

ShippingLocation

string

The shipping location for the transfer order (identifies the internal location)

ReceivingLocation

string

The receiving location for the transfer order

BuyerCode

string

The code of the buyer responsible for the item

ApprovalCode

string

The approval code for the item

ApprovedBy

string

The user who approved the item or "System" if system generated

PreOrderCarryCost

double

Pre-order carry cost associated with the item

DaysOverLeadTime

integer

Number of days the item is over lead time

Weight

double

Weight of the item

Volume

double

Volume of the item

ConversionFactor

double

Conversion factor applied to the item

BundleCode

string

Code identifying any bundle associated with the requisition

Paging

object

NextCursor

string

The cursor that identifies the next page of the payload

400

Double-check your request - you may be missing some query parameters or have provided invalid parameters

401

You are not authenticated to the API

403

You do not have access to this endpoint

404

That route doesn't exist

429

You've exceeded the rate limit

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://env.gainsystems.com/api/v1/replenishment/transfer-orders \
3
     --header 'accept: application/json'


xxxxxxxxxx
54
}
1
{
2
  "DataType": "transfer_order",
3
  "Data": [
4
    {
5
      "TrackingNumber": "string",
6
      "ShippingLocation": "string",
7
      "ReceivingLocation": "string",
8
      "SenderName": "string",
9
      "ReleaseDate": "2025-04-10",
10
      "RequestedDeliveryDate": "2025-04-10",
11
      "SubmittedBy": "string",
12
      "Documentation": "string",
13
      "ContactName": "string",
14
      "ContactEmail": "string",
15
      "ShipMethod": "string",
16
      "Address1": "string",
17
      "Address2": "string",
18
      "Address3": "string",
19
      "City": "string",
20
      "State": "string",
21
      "PostalCode": "string",
22
      "Country": "string",
23
      "UpdatedTime": "2025-04-10T12:20:03.127Z",
24
      "LineItems": [
25
        {

200Successful response containing TO recommendations