POST v1/receiveAgainstShipment

Receive an RTI against a Shipment

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PurchaseOrderItemID	Unique identifier of the Purchase Order Item	integer	None.
ShipmentID	Unique identifier of the Shipment	integer	None.
LotNumber	The lot number (if applicable)	string	None.
Quantity	The quantity of RTIs being Received	decimal number	None.
FlagType	Flag Type	FlagTypeModel	None.
TransactionID	Unique identifier of the transaction	integer	None.
StockQuantity		decimal number	None.
LabelBarcode		string	None.
CreatedBy	User who performed the receive	string	None.
Timestamp	Timestamp of when receive took place	date	None.
Barcode	Barcode that is being receoved	string	None.
PackingSlip		string	None.
ShowOverageWarning		boolean	None.
IsReceivePallet		boolean	None.
ContainerCount		integer	None.
LocationZone		LocationZoneModel	None.
SKUID		integer	None.
PartNumber		string	None.
PartDescription		string	None.
UnitCode		string	None.
ReceiveDate		date	None.
MasterLabel		string	None.
IsNewPallet		boolean	None.
PalletID		integer	None.
IsIntegrated		boolean	None.
ExpirationDate		date	None.
ReceivePreLabeled		boolean	None.
RTIID		integer	None.
FileCount		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "purchaseOrderItemID": 1,
  "shipmentID": 2,
  "lotNumber": "sample string 3",
  "quantity": 4.0,
  "flagType": {
    "flagTypeID": 1,
    "flagType": "sample string 2",
    "isActive": true,
    "isSystem": true,
    "isCleared": true,
    "isDefault": true,
    "isRepair": true,
    "isAdmin": true,
    "isRepairComponent": true
  },
  "transactionID": 5,
  "stockQuantity": 6.0,
  "labelBarcode": "sample string 7",
  "createdBy": "sample string 8",
  "timestamp": "2025-11-08T08:26:49.1730505+00:00",
  "barcode": "sample string 10",
  "packingSlip": "sample string 11",
  "showOverageWarning": true,
  "isReceivePallet": true,
  "containerCount": 14,
  "locationZone": {
    "locationZoneID": 1,
    "location": {
      "locationID": 1,
      "company": {
        "companyID": 1,
        "companyName": "sample string 2",
        "companyCode": "sample string 3",
        "vatNumber": "sample string 4",
        "address1": "sample string 5",
        "address2": "sample string 6",
        "address3": "sample string 7",
        "address4": "sample string 8",
        "address5": "sample string 9",
        "email": "sample string 10",
        "currentRates": [
          {
            "companyRateID": 1,
            "rate": 2.0,
            "supportLevel": {
              "supportLevelID": 1,
              "supportLevel": "sample string 2"
            },
            "startDate": "2025-11-08T08:26:49.1730505+00:00"
          },
          {
            "companyRateID": 1,
            "rate": 2.0,
            "supportLevel": {
              "supportLevelID": 1,
              "supportLevel": "sample string 2"
            },
            "startDate": "2025-11-08T08:26:49.1730505+00:00"
          }
        ]
      },
      "isActive": true,
      "isKeyAccount": true,
      "locationCategory": {
        "locationCategoryID": 1,
        "locationCategory": "sample string 2",
        "isSystem": true
      },
      "locationName": "sample string 4",
      "address": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "city": "sample string 8",
      "state": {
        "stateID": 1,
        "stateShortName": "sample string 2",
        "stateLongName": "sample string 3"
      },
      "zipCode": "sample string 9",
      "country": {
        "countryID": 1,
        "countryShortName": "sample string 2",
        "countryLongName": "sample string 3"
      },
      "cityStateZipCountry": "sample string 10",
      "xCoordinate": "sample string 11",
      "yCoordinate": "sample string 12",
      "googlePlaceID": "sample string 13",
      "googleURL": "sample string 14",
      "term": {
        "termID": 1,
        "term": "sample string 2",
        "isActive": true
      },
      "bolTemplate": {
        "bolTemplateID": 1,
        "templateName": "sample string 2"
      },
      "isIntegrationControlled": true,
      "locationRules": {
        "locationRuleID": 1,
        "shipMethod": {
          "shipMethodID": 1,
          "shipMethod": "sample string 2"
        },
        "isLocked": true,
        "canSelfOrder": true,
        "additionalBillingDays": 4,
        "allowUDFAddress": true,
        "palletLabelQuantity": 6,
        "returnFlagType": {
          "flagTypeID": 1,
          "flagType": "sample string 2",
          "isActive": true,
          "isSystem": true,
          "isCleared": true,
          "isDefault": true,
          "isRepair": true,
          "isAdmin": true,
          "isRepairComponent": true
        },
        "returnFlagBarcodePrefix": "sample string 7"
      }
    },
    "zoneName": "sample string 2",
    "locationZoneCategory": {
      "locationZoneCategoryID": 1,
      "locationZoneCategory": "sample string 2",
      "isActive": true,
      "isSystem": true
    },
    "operationIDs": "sample string 3",
    "moduleFeatures": [
      {
        "moduleFeatureID": 1,
        "module": {
          "moduleID": 1,
          "isCategoryFunction": true,
          "isIncluded": true,
          "moduleCategoryID": 4,
          "moduleCategory": "sample string 5",
          "moduleName": "sample string 6",
          "hasAccessType": true,
          "canWrite": true,
          "imageURL": "sample string 9",
          "routeName": "sample string 10",
          "apiRole": "sample string 11",
          "modifiedDate": "2025-11-08T08:26:49.1740447+00:00",
          "modifiedBy": "sample string 13"
        },
        "moduleFeature": "sample string 2",
        "isIncluded": true,
        "routeName": "sample string 4"
      },
      {
        "moduleFeatureID": 1,
        "module": {
          "moduleID": 1,
          "isCategoryFunction": true,
          "isIncluded": true,
          "moduleCategoryID": 4,
          "moduleCategory": "sample string 5",
          "moduleName": "sample string 6",
          "hasAccessType": true,
          "canWrite": true,
          "imageURL": "sample string 9",
          "routeName": "sample string 10",
          "apiRole": "sample string 11",
          "modifiedDate": "2025-11-08T08:26:49.1740447+00:00",
          "modifiedBy": "sample string 13"
        },
        "moduleFeature": "sample string 2",
        "isIncluded": true,
        "routeName": "sample string 4"
      }
    ]
  },
  "skuid": 15,
  "partNumber": "sample string 16",
  "partDescription": "sample string 17",
  "unitCode": "sample string 18",
  "receiveDate": "2025-11-08T08:26:49.1740447+00:00",
  "masterLabel": "sample string 20",
  "isNewPallet": true,
  "palletID": 22,
  "isIntegrated": true,
  "expirationDate": "2025-11-08T08:26:49.1740447+00:00",
  "receivePreLabeled": true,
  "rtiid": 25,
  "fileCount": 26
}

Response Information

Resource Description

ReceiveModel

Name	Description	Type	Additional information
PurchaseOrderItemID	Unique identifier of the Purchase Order Item	integer	None.
ShipmentID	Unique identifier of the Shipment	integer	None.
LotNumber	The lot number (if applicable)	string	None.
Quantity	The quantity of RTIs being Received	decimal number	None.
FlagType	Flag Type	FlagTypeModel	None.
TransactionID	Unique identifier of the transaction	integer	None.
StockQuantity		decimal number	None.
LabelBarcode		string	None.
CreatedBy	User who performed the receive	string	None.
Timestamp	Timestamp of when receive took place	date	None.
Barcode	Barcode that is being receoved	string	None.
PackingSlip		string	None.
ShowOverageWarning		boolean	None.
IsReceivePallet		boolean	None.
ContainerCount		integer	None.
LocationZone		LocationZoneModel	None.
SKUID		integer	None.
PartNumber		string	None.
PartDescription		string	None.
UnitCode		string	None.
ReceiveDate		date	None.
MasterLabel		string	None.
IsNewPallet		boolean	None.
PalletID		integer	None.
IsIntegrated		boolean	None.
ExpirationDate		date	None.
ReceivePreLabeled		boolean	None.
RTIID		integer	None.
FileCount		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "purchaseOrderItemID": 1,
  "shipmentID": 2,
  "lotNumber": "sample string 3",
  "quantity": 4.0,
  "flagType": {
    "flagTypeID": 1,
    "flagType": "sample string 2",
    "isActive": true,
    "isSystem": true,
    "isCleared": true,
    "isDefault": true,
    "isRepair": true,
    "isAdmin": true,
    "isRepairComponent": true
  },
  "transactionID": 5,
  "stockQuantity": 6.0,
  "labelBarcode": "sample string 7",
  "createdBy": "sample string 8",
  "timestamp": "2025-11-08T08:26:49.1740447+00:00",
  "barcode": "sample string 10",
  "packingSlip": "sample string 11",
  "showOverageWarning": true,
  "isReceivePallet": true,
  "containerCount": 14,
  "locationZone": {
    "locationZoneID": 1,
    "location": {
      "locationID": 1,
      "company": {
        "companyID": 1,
        "companyName": "sample string 2",
        "companyCode": "sample string 3",
        "vatNumber": "sample string 4",
        "address1": "sample string 5",
        "address2": "sample string 6",
        "address3": "sample string 7",
        "address4": "sample string 8",
        "address5": "sample string 9",
        "email": "sample string 10",
        "currentRates": [
          {
            "companyRateID": 1,
            "rate": 2.0,
            "supportLevel": {
              "supportLevelID": 1,
              "supportLevel": "sample string 2"
            },
            "startDate": "2025-11-08T08:26:49.1740447+00:00"
          },
          {
            "companyRateID": 1,
            "rate": 2.0,
            "supportLevel": {
              "supportLevelID": 1,
              "supportLevel": "sample string 2"
            },
            "startDate": "2025-11-08T08:26:49.1740447+00:00"
          }
        ]
      },
      "isActive": true,
      "isKeyAccount": true,
      "locationCategory": {
        "locationCategoryID": 1,
        "locationCategory": "sample string 2",
        "isSystem": true
      },
      "locationName": "sample string 4",
      "address": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "city": "sample string 8",
      "state": {
        "stateID": 1,
        "stateShortName": "sample string 2",
        "stateLongName": "sample string 3"
      },
      "zipCode": "sample string 9",
      "country": {
        "countryID": 1,
        "countryShortName": "sample string 2",
        "countryLongName": "sample string 3"
      },
      "cityStateZipCountry": "sample string 10",
      "xCoordinate": "sample string 11",
      "yCoordinate": "sample string 12",
      "googlePlaceID": "sample string 13",
      "googleURL": "sample string 14",
      "term": {
        "termID": 1,
        "term": "sample string 2",
        "isActive": true
      },
      "bolTemplate": {
        "bolTemplateID": 1,
        "templateName": "sample string 2"
      },
      "isIntegrationControlled": true,
      "locationRules": {
        "locationRuleID": 1,
        "shipMethod": {
          "shipMethodID": 1,
          "shipMethod": "sample string 2"
        },
        "isLocked": true,
        "canSelfOrder": true,
        "additionalBillingDays": 4,
        "allowUDFAddress": true,
        "palletLabelQuantity": 6,
        "returnFlagType": {
          "flagTypeID": 1,
          "flagType": "sample string 2",
          "isActive": true,
          "isSystem": true,
          "isCleared": true,
          "isDefault": true,
          "isRepair": true,
          "isAdmin": true,
          "isRepairComponent": true
        },
        "returnFlagBarcodePrefix": "sample string 7"
      }
    },
    "zoneName": "sample string 2",
    "locationZoneCategory": {
      "locationZoneCategoryID": 1,
      "locationZoneCategory": "sample string 2",
      "isActive": true,
      "isSystem": true
    },
    "operationIDs": "sample string 3",
    "moduleFeatures": [
      {
        "moduleFeatureID": 1,
        "module": {
          "moduleID": 1,
          "isCategoryFunction": true,
          "isIncluded": true,
          "moduleCategoryID": 4,
          "moduleCategory": "sample string 5",
          "moduleName": "sample string 6",
          "hasAccessType": true,
          "canWrite": true,
          "imageURL": "sample string 9",
          "routeName": "sample string 10",
          "apiRole": "sample string 11",
          "modifiedDate": "2025-11-08T08:26:49.1740447+00:00",
          "modifiedBy": "sample string 13"
        },
        "moduleFeature": "sample string 2",
        "isIncluded": true,
        "routeName": "sample string 4"
      },
      {
        "moduleFeatureID": 1,
        "module": {
          "moduleID": 1,
          "isCategoryFunction": true,
          "isIncluded": true,
          "moduleCategoryID": 4,
          "moduleCategory": "sample string 5",
          "moduleName": "sample string 6",
          "hasAccessType": true,
          "canWrite": true,
          "imageURL": "sample string 9",
          "routeName": "sample string 10",
          "apiRole": "sample string 11",
          "modifiedDate": "2025-11-08T08:26:49.1740447+00:00",
          "modifiedBy": "sample string 13"
        },
        "moduleFeature": "sample string 2",
        "isIncluded": true,
        "routeName": "sample string 4"
      }
    ]
  },
  "skuid": 15,
  "partNumber": "sample string 16",
  "partDescription": "sample string 17",
  "unitCode": "sample string 18",
  "receiveDate": "2025-11-08T08:26:49.1740447+00:00",
  "masterLabel": "sample string 20",
  "isNewPallet": true,
  "palletID": 22,
  "isIntegrated": true,
  "expirationDate": "2025-11-08T08:26:49.1740447+00:00",
  "receivePreLabeled": true,
  "rtiid": 25,
  "fileCount": 26
}