POST ScaleTicket/PostScaleTicket

Creates a new STLM Scale Ticket.

Request Information

URI Parameters

Body Parameters

STLM Scale Ticket object used to create a transaction.

ClsStlmTicketAdd
NameDescriptionTypeAdditional Information
TicketGuid

Provide a new UUID to save with the add of this STLM Scale Ticket

 globally unique identifier

Required
AssemblyGuid

If provided will be used to get the Assembly (Paperclip) for this Scale Ticket

 globally unique identifier
AssemblyNumber

When AssemblyGuid is null, will be used to look up the Assembly (Paperclip) in addition to the AssemblyLocationId

 string

Max length: 20
AssemblyLocationId

When AssemblyGuid is null, will be used to look up the Assembly (Paperclip) in addition to the AssemblyNumber

 string

Max length: 6
TicketPrefix

The Prefix to the Scale Ticket Number

 string

Max length: 10
TicketNumber

The Number portion of the Scale Ticket Number

 integer

Cannot be negative
TicketSuffix

The Suffix to the Scale Ticket Number

 string

Max length: 10
ConcatenatedScaleTicketNumber

When the Prefix, Number, and Suffix are all null, will be used to parse and create the individual parts of the ticket that are saved in the database

 string

Max length: 30
TicketDate

The Date of the Scale Ticket

 string

Required

Format must be MM/dd/yyyy
BasePrice

When provided - the Base Price of the ticket used as the Spot Price for non-contracted 'Priced' dispositions

 decimal number

Max of 4 decimal places
FarmGuid

When provided - the GUID of the farm to use for this Scale Ticket

 globally unique identifier
FieldGuid

When provided - the GUID of the field to use for this Scale Ticket. If the farm is identified, this field must belong to that farm

 globally unique identifier
GrowerIdForFarmFieldLookup

When the Farm or Field GUIDs are not provided - used to look up the GUIDs from the DB in addition to the FarmId and FieldId

 string

Max length: 6
FarmId

When the FarmGuid is null, will be used with the GrowerIdForFarmFieldLookup to get the GUID of the farm to use for this Scale Ticket

 string

Max length: 8
FieldId

When the FieldGuid is null, will be used with the GrowerIdForFarmFieldLookup to get the GUID of the field to use for this Scale Ticket. If the farm is identified, this field must belong to that farm

 string

Max length: 8
LotNumber

The Lot Number of the Scale Ticket

 string

Max length: 30
GrossWeight

Optional Gross Weight of the Scale Ticket

 integer
TareWeight

Optional Tare Weight of the Scale Ticket

 integer
NetWeight

The Net Weight of the Scale Ticket. IF the Gross or Tare Weights are included, this must calculate out from those values

 integer

Required

Cannot be negative
GrossUnits

The Gross Units of the Scale Ticket. IF the Gross or Tare Weights are included, this must calculate from the Net Weight / Commodity Lbs/Unit rounded to Commodity Decimal Accuracy

 decimal number

Required

Cannot be negative

Max of 4 decimal places
CommodityVariety

The Commodity Variety of the Scale Ticket - will honor the requirement of this being required from the database

 string

Max length: 50
BinGuid

When provided - the GUID of the Bin of the Scale Ticket

 globally unique identifier
BinId

When BinGuid is null - will be used to look up the identifier for the Bin of the Scale Ticket

 string

Max length: 10
BOLNumber

The BOL Number of the Scale Ticket

 string

Max length: 15
FreightVendorGuid

When provided - the GUID of the Freight Vendor of the Scale Ticket

 globally unique identifier
FreightVendorId

When FreightVendorGuid is null - will be used to look up the identifer for the Freight Vendor of the Scale Ticket

 string

Max length: 10
Comments

The Comments of the Scale Ticket

 string

Max length: 60
DirectShipped

An indication of if the Scale Ticket was Direct Shipped or not

 boolean
ShippingDestinationGuid

When provided - the GUID of the Shipping Destination - ONLY valid when DirectShipped is true

 globally unique identifier
ShippingDestinationId

When ShippingDestinationGuid is null - will be used to look up the identifer for the Shipping Destination - ONLY valid when DirectShipped is true

 string

Max length: 6
CustomerSplits

List of customer splits of the Scale Ticket

 Collection of ClsStlmTicketAddSplit

List cannot be empty
GradeFactors

List of grade factors of the Scale Ticket. Must exist on the commodity of the Assembly and not be duplicated. All grade factors from the Assembly Commodity will default with their default results. These will be used to override those values. The Premium Discount dollars will ONLY be recalculated when the PD Schedule is valid and the property "CalculatePremiumDiscountValueFromSchedule" is set to "true"

 Collection of ClsStlmTicketAddGradFact
FreightCharges

List of Freight Vendors and the rate to charge. The quantity used will be the Gross Units of the Scale Ticket

 Collection of ClsStlmTicketAddFreight

Request Formats

application/json, text/json

Sample: 
{
  "TicketGuid": "c99a487f-1016-435c-a032-3f437fa5688a",
  "AssemblyGuid": "76dc30c2-dcfb-4806-94e7-0c912cd063ea",
  "AssemblyNumber": "sample string 5",
  "AssemblyLocationId": "sample string 6",
  "TicketPrefix": "sample string 7",
  "TicketNumber": 1,
  "TicketSuffix": "sample string 8",
  "ConcatenatedScaleTicketNumber": "sample string 9",
  "TicketDate": "sample string 10",
  "BasePrice": 1.1,
  "FarmGuid": "20e554e8-5928-43a6-8a33-ba07600f88c0",
  "FieldGuid": "322ab6c8-f7c7-443e-b5cf-ffb49b8b4978",
  "GrowerIdForFarmFieldLookup": "sample string 11",
  "FarmId": "sample string 12",
  "FieldId": "sample string 13",
  "LotNumber": "sample string 14",
  "GrossWeight": 1,
  "TareWeight": 1,
  "NetWeight": 15,
  "GrossUnits": 16.1,
  "CommodityVariety": "sample string 17",
  "BinGuid": "c00ff803-5202-4a1e-b60b-e79254e9b9f7",
  "BinId": "sample string 18",
  "BOLNumber": "sample string 19",
  "FreightVendorGuid": "622af353-ac80-48fb-be8e-653dec462a7b",
  "FreightVendorId": "sample string 20",
  "Comments": "sample string 21",
  "DirectShipped": true,
  "ShippingDestinationGuid": "7ab5900f-9d24-4619-bdb5-c9507c426291",
  "ShippingDestinationId": "sample string 23",
  "CustomerSplits": [
    {
      "CustomerGuid": "25c46615-818e-46d8-9c99-0655651663b9",
      "CustomerId": "sample string 1",
      "SplitPercent": 1.1,
      "GrossUnits": 2.1,
      "Disposition": "sample string 3",
      "PurchaseContractGuid": "4076297f-fe72-421c-a011-f3058e5f36b4",
      "PurchaseContractNumber": "sample string 4",
      "PurchaseContractLocationId": "sample string 5",
      "ShrinkTableGuid": "b0c57434-2596-445c-9fd9-91360ed56e2b",
      "ShrinkTableGradeFactor": "sample string 6",
      "ShrinkTableSchedule": "sample string 7",
      "DockageTableGuid": "7a09a405-2c7e-4c2a-9063-f5999164afdd",
      "DockageTableGradeFactor": "sample string 8",
      "DockageTableSchedule": "sample string 9",
      "DryingTableGuid": "e0719a01-4ee7-4d8b-b023-43bb99e97a36",
      "DryingTableGradeFactor": "sample string 10",
      "DryingTableSchedule": "sample string 11",
      "ChargeScheduleGuid": "c606c96c-72a4-46b8-9f56-1276abaa63a7",
      "ChargeScheduleId": "sample string 12",
      "CondoStorage": true,
      "FreightPercent": 1.1,
      "OpenStorageOnHold": true
    },
    {
      "CustomerGuid": "25c46615-818e-46d8-9c99-0655651663b9",
      "CustomerId": "sample string 1",
      "SplitPercent": 1.1,
      "GrossUnits": 2.1,
      "Disposition": "sample string 3",
      "PurchaseContractGuid": "4076297f-fe72-421c-a011-f3058e5f36b4",
      "PurchaseContractNumber": "sample string 4",
      "PurchaseContractLocationId": "sample string 5",
      "ShrinkTableGuid": "b0c57434-2596-445c-9fd9-91360ed56e2b",
      "ShrinkTableGradeFactor": "sample string 6",
      "ShrinkTableSchedule": "sample string 7",
      "DockageTableGuid": "7a09a405-2c7e-4c2a-9063-f5999164afdd",
      "DockageTableGradeFactor": "sample string 8",
      "DockageTableSchedule": "sample string 9",
      "DryingTableGuid": "e0719a01-4ee7-4d8b-b023-43bb99e97a36",
      "DryingTableGradeFactor": "sample string 10",
      "DryingTableSchedule": "sample string 11",
      "ChargeScheduleGuid": "c606c96c-72a4-46b8-9f56-1276abaa63a7",
      "ChargeScheduleId": "sample string 12",
      "CondoStorage": true,
      "FreightPercent": 1.1,
      "OpenStorageOnHold": true
    }
  ],
  "GradeFactors": [
    {
      "GradeFactorGuid": "db3fd0e5-5a75-494d-ace1-9daa0f94df05",
      "GradeFactorId": "sample string 1",
      "Result": 1.1,
      "PremiumDiscountValue": 1.1,
      "PremiumDiscountTableGuid": "609a1d26-1d64-40ea-917e-01668dfc0687",
      "PremiumDiscountTableSchedule": "sample string 2",
      "CalculatePremiumDiscountValueFromSchedule": true
    },
    {
      "GradeFactorGuid": "db3fd0e5-5a75-494d-ace1-9daa0f94df05",
      "GradeFactorId": "sample string 1",
      "Result": 1.1,
      "PremiumDiscountValue": 1.1,
      "PremiumDiscountTableGuid": "609a1d26-1d64-40ea-917e-01668dfc0687",
      "PremiumDiscountTableSchedule": "sample string 2",
      "CalculatePremiumDiscountValueFromSchedule": true
    }
  ],
  "FreightCharges": [
    {
      "FreightVendorGuid": "20a6ff24-ceee-48af-8fe6-f7be3f087a20",
      "FreightVendorId": "sample string 1",
      "Rate": 1.1
    },
    {
      "FreightVendorGuid": "20a6ff24-ceee-48af-8fe6-f7be3f087a20",
      "FreightVendorId": "sample string 1",
      "Rate": 1.1
    }
  ]
}

application/xml, text/xml

Sample: 
<ClsStlmTicketAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.Grain">
  <AssemblyGuid>76dc30c2-dcfb-4806-94e7-0c912cd063ea</AssemblyGuid>
  <AssemblyLocationId>sample string 6</AssemblyLocationId>
  <AssemblyNumber>sample string 5</AssemblyNumber>
  <BOLNumber>sample string 19</BOLNumber>
  <BasePrice>1.1</BasePrice>
  <BinGuid>c00ff803-5202-4a1e-b60b-e79254e9b9f7</BinGuid>
  <BinId>sample string 18</BinId>
  <Comments>sample string 21</Comments>
  <CommodityVariety>sample string 17</CommodityVariety>
  <ConcatenatedScaleTicketNumber>sample string 9</ConcatenatedScaleTicketNumber>
  <CustomerSplits>
    <ClsStlmTicketAddSplit>
      <ChargeScheduleGuid>c606c96c-72a4-46b8-9f56-1276abaa63a7</ChargeScheduleGuid>
      <ChargeScheduleId>sample string 12</ChargeScheduleId>
      <CondoStorage>true</CondoStorage>
      <CustomerGuid>25c46615-818e-46d8-9c99-0655651663b9</CustomerGuid>
      <CustomerId>sample string 1</CustomerId>
      <Disposition>sample string 3</Disposition>
      <DockageTableGradeFactor>sample string 8</DockageTableGradeFactor>
      <DockageTableGuid>7a09a405-2c7e-4c2a-9063-f5999164afdd</DockageTableGuid>
      <DockageTableSchedule>sample string 9</DockageTableSchedule>
      <DryingTableGradeFactor>sample string 10</DryingTableGradeFactor>
      <DryingTableGuid>e0719a01-4ee7-4d8b-b023-43bb99e97a36</DryingTableGuid>
      <DryingTableSchedule>sample string 11</DryingTableSchedule>
      <FreightPercent>1.1</FreightPercent>
      <GrossUnits>2.1</GrossUnits>
      <OpenStorageOnHold>true</OpenStorageOnHold>
      <PurchaseContractGuid>4076297f-fe72-421c-a011-f3058e5f36b4</PurchaseContractGuid>
      <PurchaseContractLocationId>sample string 5</PurchaseContractLocationId>
      <PurchaseContractNumber>sample string 4</PurchaseContractNumber>
      <ShrinkTableGradeFactor>sample string 6</ShrinkTableGradeFactor>
      <ShrinkTableGuid>b0c57434-2596-445c-9fd9-91360ed56e2b</ShrinkTableGuid>
      <ShrinkTableSchedule>sample string 7</ShrinkTableSchedule>
      <SplitPercent>1.1</SplitPercent>
    </ClsStlmTicketAddSplit>
    <ClsStlmTicketAddSplit>
      <ChargeScheduleGuid>c606c96c-72a4-46b8-9f56-1276abaa63a7</ChargeScheduleGuid>
      <ChargeScheduleId>sample string 12</ChargeScheduleId>
      <CondoStorage>true</CondoStorage>
      <CustomerGuid>25c46615-818e-46d8-9c99-0655651663b9</CustomerGuid>
      <CustomerId>sample string 1</CustomerId>
      <Disposition>sample string 3</Disposition>
      <DockageTableGradeFactor>sample string 8</DockageTableGradeFactor>
      <DockageTableGuid>7a09a405-2c7e-4c2a-9063-f5999164afdd</DockageTableGuid>
      <DockageTableSchedule>sample string 9</DockageTableSchedule>
      <DryingTableGradeFactor>sample string 10</DryingTableGradeFactor>
      <DryingTableGuid>e0719a01-4ee7-4d8b-b023-43bb99e97a36</DryingTableGuid>
      <DryingTableSchedule>sample string 11</DryingTableSchedule>
      <FreightPercent>1.1</FreightPercent>
      <GrossUnits>2.1</GrossUnits>
      <OpenStorageOnHold>true</OpenStorageOnHold>
      <PurchaseContractGuid>4076297f-fe72-421c-a011-f3058e5f36b4</PurchaseContractGuid>
      <PurchaseContractLocationId>sample string 5</PurchaseContractLocationId>
      <PurchaseContractNumber>sample string 4</PurchaseContractNumber>
      <ShrinkTableGradeFactor>sample string 6</ShrinkTableGradeFactor>
      <ShrinkTableGuid>b0c57434-2596-445c-9fd9-91360ed56e2b</ShrinkTableGuid>
      <ShrinkTableSchedule>sample string 7</ShrinkTableSchedule>
      <SplitPercent>1.1</SplitPercent>
    </ClsStlmTicketAddSplit>
  </CustomerSplits>
  <DirectShipped>true</DirectShipped>
  <FarmGuid>20e554e8-5928-43a6-8a33-ba07600f88c0</FarmGuid>
  <FarmId>sample string 12</FarmId>
  <FieldGuid>322ab6c8-f7c7-443e-b5cf-ffb49b8b4978</FieldGuid>
  <FieldId>sample string 13</FieldId>
  <FreightCharges>
    <ClsStlmTicketAddFreight>
      <FreightVendorGuid>20a6ff24-ceee-48af-8fe6-f7be3f087a20</FreightVendorGuid>
      <FreightVendorId>sample string 1</FreightVendorId>
      <Rate>1.1</Rate>
    </ClsStlmTicketAddFreight>
    <ClsStlmTicketAddFreight>
      <FreightVendorGuid>20a6ff24-ceee-48af-8fe6-f7be3f087a20</FreightVendorGuid>
      <FreightVendorId>sample string 1</FreightVendorId>
      <Rate>1.1</Rate>
    </ClsStlmTicketAddFreight>
  </FreightCharges>
  <FreightVendorGuid>622af353-ac80-48fb-be8e-653dec462a7b</FreightVendorGuid>
  <FreightVendorId>sample string 20</FreightVendorId>
  <GradeFactors>
    <ClsStlmTicketAddGradFact>
      <CalculatePremiumDiscountValueFromSchedule>true</CalculatePremiumDiscountValueFromSchedule>
      <GradeFactorGuid>db3fd0e5-5a75-494d-ace1-9daa0f94df05</GradeFactorGuid>
      <GradeFactorId>sample string 1</GradeFactorId>
      <PremiumDiscountTableGuid>609a1d26-1d64-40ea-917e-01668dfc0687</PremiumDiscountTableGuid>
      <PremiumDiscountTableSchedule>sample string 2</PremiumDiscountTableSchedule>
      <PremiumDiscountValue>1.1</PremiumDiscountValue>
      <Result>1.1</Result>
    </ClsStlmTicketAddGradFact>
    <ClsStlmTicketAddGradFact>
      <CalculatePremiumDiscountValueFromSchedule>true</CalculatePremiumDiscountValueFromSchedule>
      <GradeFactorGuid>db3fd0e5-5a75-494d-ace1-9daa0f94df05</GradeFactorGuid>
      <GradeFactorId>sample string 1</GradeFactorId>
      <PremiumDiscountTableGuid>609a1d26-1d64-40ea-917e-01668dfc0687</PremiumDiscountTableGuid>
      <PremiumDiscountTableSchedule>sample string 2</PremiumDiscountTableSchedule>
      <PremiumDiscountValue>1.1</PremiumDiscountValue>
      <Result>1.1</Result>
    </ClsStlmTicketAddGradFact>
  </GradeFactors>
  <GrossUnits>16.1</GrossUnits>
  <GrossWeight>1</GrossWeight>
  <GrowerIdForFarmFieldLookup>sample string 11</GrowerIdForFarmFieldLookup>
  <LotNumber>sample string 14</LotNumber>
  <NetWeight>15</NetWeight>
  <ShippingDestinationGuid>7ab5900f-9d24-4619-bdb5-c9507c426291</ShippingDestinationGuid>
  <ShippingDestinationId>sample string 23</ShippingDestinationId>
  <TareWeight>1</TareWeight>
  <TicketDate>sample string 10</TicketDate>
  <TicketGuid>c99a487f-1016-435c-a032-3f437fa5688a</TicketGuid>
  <TicketNumber>1</TicketNumber>
  <TicketPrefix>sample string 7</TicketPrefix>
  <TicketSuffix>sample string 8</TicketSuffix>
</ClsStlmTicketAdd>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsStlmTicketAdd'.

Response Information

Resource Description

Creates a new STLM Scale Ticket.

AgvStlmScaleTicket
NameDescriptionTypeAdditional Information
Status

0 - Success; 1 - An error occurred; 2 - An error occurred; 3 - Descriptive message, process was successful

 string
Message

Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know

 string
ErrorList

List of error messages of the API call.

 Collection of string
WarningList

List of warning messages of the API call.

 Collection of string
Count

Number of results returned

 string
Data

List of properties and values returned for each STLM Scale Ticket that matches the request

 Collection of ClsStlmScaleTicketApi

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "Data": [
    {
      "ScaleTicketGuid": "50c929a7-f0f2-4b15-8e23-b79bee624736",
      "TicketDate": "2025-08-23T07:29:43.5719714+00:00",
      "AssemblyNumber": "sample string 3",
      "LocationId": "sample string 4",
      "ConcatinatedScaleTicketNumber": "sample string 51sample string 6"
    },
    {
      "ScaleTicketGuid": "50c929a7-f0f2-4b15-8e23-b79bee624736",
      "TicketDate": "2025-08-23T07:29:43.5719714+00:00",
      "AssemblyNumber": "sample string 3",
      "LocationId": "sample string 4",
      "ConcatinatedScaleTicketNumber": "sample string 51sample string 6"
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'ScaleTicketNumber' in type 'SKY.Core.Grain.ClsGrPaperclipScaleTick+ClsStlmScaleTicketApi'.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'ScaleTicketNumber' in type 'SKY.Core.Grain.ClsGrPaperclipScaleTick+ClsStlmScaleTicketApi'.